diff --git a/docs/index.rst b/docs/index.rst index 69d1cb4..411aca5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,12 +37,12 @@ Horizon 2020 research and innovation program under grant agreement No 101004110. :caption: Contents: install - notebooks/scanninglaw notebooks/getting-started notebooks/dr3-empirical-completeness notebooks/dr3-rvs notebooks/SubsampleSelectionFunction notebooks/SubsampleSF_Tutorial + notebooks/scanninglaw citation api diff --git a/docs/install.rst b/docs/install.rst index 44a0e7b..cdb5cf2 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,4 +1,4 @@ -Installation +Installation and quickstart ------------ The package is available through PyPI and Github. @@ -25,7 +25,32 @@ Alternatively, clone the repository and install: In case a local installation is not possible, the package can also be installed inside a Google Colab notebook by executing the command ``!pip install gaiaunlimited`` or ``%pip install gaiaunlimited``. -Setting the data directory + +Plotting the Gaia DR3 selection function on the sky +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This code queries a precomputed all-sky map and displays the completeness at magnitude 21: + +.. code-block:: bash + + from gaiaunlimited.selectionfunctions import DR3SelectionFunctionTCG + from gaiaunlimited.utils import get_healpix_centers + import numpy as np + import healpy as hp + + mapHpx7 = DR3SelectionFunctionTCG() + coords_of_centers = get_healpix_centers(5) + gmag = np.ones_like(coords_of_centers) * 21. + completeness = mapHpx7.query(coords_of_centers,gmag) + hp.mollview(completeness,coord=['Celestial','Galactic'], + title='Gaia DR3 selection function at G=21', + min=0,max=1) + +.. image:: notebooks/_static/dr3_tcg_g21.png + :width: 600 + + +Optional: setting the data directory ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Gaiaunlimited downloads and caches large binary data files. To set the data directory to store these files, diff --git a/docs/notebooks/_static/dr3_tcg_g21.png b/docs/notebooks/_static/dr3_tcg_g21.png new file mode 100644 index 0000000..e208c4e Binary files /dev/null and b/docs/notebooks/_static/dr3_tcg_g21.png differ