Todo List

Todo

  • update the package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/catalogue_conesearch.py:docstring of sherlock.catalogue_conesearch.catalogue_conesearch, line 25.)

Todo

  • docuument cl_utils module

  • tidy usage text

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/cl_utils.py:docstring of sherlock.cl_utils, line 7.)

Todo

  • write a checklist for adding a new catalogue to the sherlock database and reference it from here (use the image below of the tcs_helper_catalogue_views_info table)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/commonutils/get_crossmatch_catalogues_column_map.py:docstring of sherlock.commonutils.get_crossmatch_catalogues_column_map.get_crossmatch_catalogues_column_map, line 7.)

Todo

  • add an entry in the tutorial to clean database tables

```python from sherlock.database_cleaner import database_cleaner db = database_cleaner(

log=log, settings=settings

) db.clean() ```

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner.database_cleaner, line 15.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner.database_cleaner._create_tcs_help_tables, line 25.)

Todo

  • update the package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier, line 26.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • update package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier._consolidate_coordinateList, line 16.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.classification_annotations, line 16.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.update_classification_annotations_and_summaries, line 19.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.update_peak_magnitudes, line 16.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier._create_tables_if_not_exist, line 16.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.generate_match_annotation, line 25.)

Todo

  • update the package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/catalogue_conesearch.py:docstring of sherlock.catalogue_conesearch.catalogue_conesearch, line 25.)

Todo

  • write a checklist for adding a new catalogue to the sherlock database and reference it from here (use the image below of the tcs_helper_catalogue_views_info table)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/commonutils/get_crossmatch_catalogues_column_map.py:docstring of sherlock.commonutils.get_crossmatch_catalogues_column_map.get_crossmatch_catalogues_column_map, line 7.)

Todo

  • add an entry in the tutorial to clean database tables

```python from sherlock.database_cleaner import database_cleaner db = database_cleaner(

log=log, settings=settings

) db.clean() ```

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/database_cleaner.py:docstring of sherlock.database_cleaner.database_cleaner, line 15.)

Todo

  • update the package tutorial if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier, line 26.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.classification_annotations, line 16.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.generate_match_annotation, line 25.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.update_classification_annotations_and_summaries, line 19.)

Todo

  • add usage info

  • create a sublime snippet for usage

  • write a command-line tool for this method

  • update package tutorial with command-line tool info if needed

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/envs/develop/lib/python3.7/site-packages/qub_sherlock-2.2.0-py3.7.egg/sherlock/transient_classifier.py:docstring of sherlock.transient_classifier.transient_classifier.update_peak_magnitudes, line 16.)

Todo

  • nice!

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/qub-sherlock/checkouts/develop/docs/source/_template_.md, line 1.)