Commit d9324daf authored by karpov-sv's avatar karpov-sv
Browse files

Simple TODO page added

parent 683de3cf
......@@ -3,7 +3,7 @@ Reference catalogues
In order to perform :doc:`astrometric <astrometry>` and :doc:`photometric <photometry>` calibrations, you will need a reference catalogue. For *STDPipe*, any table that contains sky positions of the stars and their magnitudes will work - so you may either construct it yourself, load from file or database, or download from Internet.
For the latter, we have a convenience routine :func:`stdpipe.catalogs.get_cat_vizier` that helps accessing any catalogue available in `Vizier <https://vizier.cds.unistra.fr>`_.
For the latter, we have a convenience routine :func:`stdpipe.catalogs.get_cat_vizier` that helps accessing any catalogue available in `Vizier <https://vizier.cds.unistra.fr>`__.
For some of them we have a special support - we automatically augment them with magnitudes in photometric bands not originally present there. To do so, we use the following sources of photometric transformations:
......@@ -31,13 +31,18 @@ The following example shows how to get a reference catalogue for a given image
filters={'rmag':'<18'})
print(len(cat), 'catalogue stars')
.. attention::
These catalogue-access functions all use `Astroquery <https://astroquery.readthedocs.io/en/latest/>`__ package to do the actual work. It caches the results (so that consecutive queries to the same region of the same catalogue do not need to re-download the data) inside your home directory - in the :file:`~/.astropy/cache/astropy/` directory. There is no built-in way to limit its size yet - so you will need to monitor its disk space usage, and probably clean it up manually from time to time!
.. autofunction:: stdpipe.catalogs.get_cat_vizier
:noindex:
Cross-matching with Vizier catalogues
-------------------------------------
*STDPipe* also has a couple of convenience routines for cross-matching object lists with Vizier catalogues that use `CDS XMatch service <http://cdsxmatch.u-strasbg.fr>`_, as well as with Solar system objects using `IMCCE SkyBoT service <http://vo.imcce.fr/webservices/skybot/>`_. Both are thin wrappers around corresponding routines from `Astroquery <https://astroquery.readthedocs.io/en/latest/index.html>`_ package.
*STDPipe* also has a couple of convenience routines for cross-matching object lists with Vizier catalogues that use `CDS XMatch service <http://cdsxmatch.u-strasbg.fr>`__, as well as with Solar system objects using `IMCCE SkyBoT service <http://vo.imcce.fr/webservices/skybot/>`__. Both are thin wrappers around corresponding routines from `Astroquery <https://astroquery.readthedocs.io/en/latest/index.html>`__ package.
.. autofunction:: stdpipe.catalogs.xmatch_objects
:noindex:
......
......@@ -28,6 +28,7 @@ User Guide
installation
usage
todo
contributing
API documentation <api/modules>
......
TODO list
=========
*STDPipe* development is ongoing - that means we have not yet implemented all the things we want. So here is an (obviously) incomplete list of these things:
- Improve the documentation and tutorials to better demonstrate the usage of *STDPipe* in real world
- Create unit testing infrastructure!
- Implement some cache control routines that would control the disk usage by Astroquery-based routines, as well as Pan-STARRS image download ones
- Re-work the local caching of original Pan-STARRS images to both reduce their sizes (e.g. downscale them if you do not need them in full resolution for your analysis) and make downloads more reliable if something fails
- Implement some sort of limiting magnitude estimation routine for convenience
- ...
If you have some other ideas in mind about what might be implemented
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment