diff --git a/doc/index.rst b/doc/index.rst index a00777492..52c2c0b13 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,6 +15,7 @@ List of submodules: * :doc:`rubin_sim.data ` provides a minimal tool to track the location of the associated downloaded data (see rs_download_data). * :doc:`rubin_sim.phot_utils ` provides synthetic photometry and SNR tools. * :doc:`rubin_sim.satellite_constellations ` tools for mega satellite constellations. +* :doc:`rubin_sim.selfcal ` generating stellar catalogs and running self-calibration. * :doc:`rubin_sim.site_models ` provides tools to interact with our models for seeing and weather, as well as almanacs of sunrise/sunset. * :doc:`rubin_sim.skybrightness ` can generate predicted skybrightness values for the Rubin site. * :doc:`rubin_sim.skybrightness_pre ` provides pre-calculated versions of the skybrightness for the lifetime of LSST. diff --git a/doc/rs_selfcal/index.rst b/doc/rs_selfcal/index.rst new file mode 100644 index 000000000..0d84f0b1b --- /dev/null +++ b/doc/rs_selfcal/index.rst @@ -0,0 +1,17 @@ +.. py:currentmodule:: rubin_sim.selfcal + +.. _rubin_sim.selfcal: + +================= +rubin_sim selfcal +================= + +Tools for simulating self-calibration. + + +Python API +========== + +* :ref:`rubin_sim.selfcal api` + +* :ref:`search` diff --git a/doc/rubin_sim/index.rst b/doc/rubin_sim/index.rst index 22e93c6f4..ead4cc2be 100644 --- a/doc/rubin_sim/index.rst +++ b/doc/rubin_sim/index.rst @@ -49,6 +49,14 @@ Python API :no-main-docstr: :no-inheritance-diagram: +.. _rubin_sim.selfcal api: + +:doc:`rubin_sim.selfcal api <../rs_selfcal/index>` +====================================================== +.. automodapi:: rubin_sim.selfcal + :no-main-docstr: + :no-inheritance-diagram: + .. _rubin_sim.site_models api: :doc:`rubin_sim.site_models api <../rs_site_models/index>` diff --git a/doc/toc.rst b/doc/toc.rst index 7e0c2903e..930efcc1a 100644 --- a/doc/toc.rst +++ b/doc/toc.rst @@ -10,6 +10,7 @@ Table of contents rs_data/* rs_phot_utils/* rs_satellite_constellations/* + rs_selfcal/* rs_site_models/* rs_skybrightness/* rs_skybrightness_pre/* diff --git a/rubin_sim/selfcal/generate_catalog.py b/rubin_sim/selfcal/generate_catalog.py index 7ce7543d7..0011ba20c 100644 --- a/rubin_sim/selfcal/generate_catalog.py +++ b/rubin_sim/selfcal/generate_catalog.py @@ -8,7 +8,9 @@ from .offsets import OffsetSNR from .star_tools import assign_patches, stars_project -__all__ = "generate_catalog" +__all__ = [ + "generate_catalog", +] def wrap_ra(ra): diff --git a/rubin_sim/selfcal/offsets.py b/rubin_sim/selfcal/offsets.py index b797646e6..ffe271a98 100644 --- a/rubin_sim/selfcal/offsets.py +++ b/rubin_sim/selfcal/offsets.py @@ -1,3 +1,5 @@ +__all__ = ["NoOffset", "OffsetSNR", "BaseOffset"] + import numpy as np from rubin_sim.maf import m52snr diff --git a/rubin_sim/selfcal/solver.py b/rubin_sim/selfcal/solver.py index 19ffcc90b..387e7739d 100644 --- a/rubin_sim/selfcal/solver.py +++ b/rubin_sim/selfcal/solver.py @@ -1,3 +1,5 @@ +__all__ = ("LsqrSolver",) + import numpy as np from scipy.sparse import coo_matrix from scipy.sparse.linalg import lsqr