DM-39490 Yoachim

doc/conf.py

@@ -62,7 +62,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

doc/index.rst

@@ -14,6 +14,8 @@ List of submodules:
 * :doc:`rubin_sim.utils <rs_utils/index>` provides some basic utilities we use throughout the rest of rubin_sim, but may be useful for other purposes.
 * :doc:`rubin_sim.data <rs_data/index>` provides a minimal tool to track the location of the associated downloaded data (see rs_download_data).
 * :doc:`rubin_sim.phot_utils <rs_phot_utils/index>` provides synthetic photometry and SNR tools.
+* :doc:`rubin_sim.satellite_constellations <rs_satellite_constellations/index>` tools for mega satellite constellations.
+* :doc:`rubin_sim.selfcal <rs_selfcal/index>` generating stellar catalogs and running self-calibration.
 * :doc:`rubin_sim.site_models <rs_site_models/index>` provides tools to interact with our models for seeing and weather, as well as almanacs of sunrise/sunset.
 * :doc:`rubin_sim.skybrightness <rs_skybrightness/index>` can generate predicted skybrightness values for the Rubin site.
 * :doc:`rubin_sim.skybrightness_pre <rs_skybrightness_pre/index>` provides pre-calculated versions of the skybrightness for the lifetime of LSST.

doc/metric_list.py

@@ -1,4 +1,4 @@
-__all__ = ("make_metric_list", )
+__all__ = ("make_metric_list",)
 
 import inspect
 

doc/rs_satellite_constellations/index.rst

@@ -0,0 +1,17 @@
+.. py:currentmodule:: rubin_sim.satellite_constellations
+
+.. _rubin_sim.satellite_constellations:
+
+==================================
+rubin_sim satellite constellations
+==================================
+
+Tools for creating and propigating satellite mega constellations and how they could streak Rubin images.
+
+
+Python API
+==========
+
+* :ref:`rubin_sim.satellite_constellations api`
+
+* :ref:`search`

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`

doc/rubin_sim/index.rst

@@ -34,13 +34,29 @@ Python API
 
 .. _rubin_sim.phot_utils api:
 
-:doc:`rubin_sim.photUtils api <../rs_phot_utils/index>`
+:doc:`rubin_sim.phot_utils api <../rs_phot_utils/index>`
 ======================================================
 .. automodapi:: rubin_sim.phot_utils
    :no-main-docstr:
    :no-inheritance-diagram:
 
 
+.. _rubin_sim.satellite_constellations api:
+
+:doc:`rubin_sim.satellite_constellations api <../rs_satellite_constellations/index>`
+======================================================
+.. automodapi:: rubin_sim.satellite_constellations
+   :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>`

doc/toc.rst

@@ -9,6 +9,8 @@ Table of contents
    rs_utils/*
    rs_data/*
    rs_phot_utils/*
+   rs_satellite_constellations/*
+   rs_selfcal/*
    rs_site_models/*
    rs_skybrightness/*
    rs_skybrightness_pre/*

rubin_sim/maf/batches/ddf_batch.py

@@ -1,4 +1,4 @@
-__all__ = ("ddfBatch", )
+__all__ = ("ddfBatch",)
 
 import healpy as hp
 import numpy as np

rubin_sim/maf/batches/glance_batch.py

@@ -1,4 +1,4 @@
-__all__ = ("glanceBatch", )
+__all__ = ("glanceBatch",)
 
 import warnings
 

rubin_sim/maf/batches/hourglass_batch.py

@@ -1,6 +1,6 @@
 """Run the hourglass metric.
 """
-__all__ = ("hourglassPlots", )
+__all__ = ("hourglassPlots",)
 
 import rubin_sim.maf.metric_bundles as mb
 import rubin_sim.maf.metrics as metrics

rubin_sim/maf/batches/info_batch.py

@@ -1,4 +1,4 @@
-__all__ = ("metadata_bundle_dicts", )
+__all__ = ("metadata_bundle_dicts",)
 
 import numpy as np
 

rubin_sim/maf/batches/openshutter_batch.py

@@ -1,6 +1,6 @@
 """Evaluate the open shutter fraction.
 """
-__all__ = ("openshutterFractions", )
+__all__ = ("openshutterFractions",)
 
 import rubin_sim.maf.metric_bundles as mb
 import rubin_sim.maf.metrics as metrics

rubin_sim/maf/batches/science_radar_batch.py

@@ -1,4 +1,4 @@
-__all__ = ("science_radar_batch", )
+__all__ = ("science_radar_batch",)
 
 import astropy.units as u
 import healpy as hp

rubin_sim/maf/batches/time_sci_batch.py

@@ -1,6 +1,6 @@
 """Sets of metrics to look at impact of cadence on science
 """
-__all__ = ("phaseGap", )
+__all__ = ("phaseGap",)
 
 import numpy as np
 

rubin_sim/maf/db/add_run.py

@@ -1,4 +1,4 @@
-__all__ = ("add_run", )
+__all__ = ("add_run",)
 
 import argparse
 

rubin_sim/maf/ddf_dir.py

@@ -1,4 +1,4 @@
-__all__ = ("ddf_dir", )
+__all__ = ("ddf_dir",)
 
 import matplotlib
 

rubin_sim/maf/glance_dir.py

@@ -1,4 +1,4 @@
-__all__ = ("glance_dir", )
+__all__ = ("glance_dir",)
 
 import matplotlib
 

rubin_sim/maf/maf_contrib/calc_expected_visits.py

@@ -5,7 +5,7 @@
 @author: rstreet
 """
 
-__all__ = ("CalcExpectedVisitsMetric", )
+__all__ = ("CalcExpectedVisitsMetric",)
 
 import numpy as np
 

rubin_sim/maf/maf_contrib/example_new_metrics.py

@@ -1,7 +1,7 @@
 # Example of a new metric added to the repo.
 # ljones@astro.washington.edu
 
-__all__ = ("NightsWithNFiltersMetric", )
+__all__ = ("NightsWithNFiltersMetric",)
 
 import numpy as np
 

rubin_sim/maf/maf_contrib/example_new_stacker.py

@@ -1,7 +1,7 @@
 # Example of a stacker added to the repo.
 # ljones@astro.washington.edu
 
-__all__ = ("YearlyDitherStacker", )
+__all__ = ("YearlyDitherStacker",)
 
 import numpy as np
 

rubin_sim/maf/maf_contrib/filter_pair_t_gaps_metric.py

@@ -1,4 +1,4 @@
-__all__ = ("FilterPairTGapsMetric", )
+__all__ = ("FilterPairTGapsMetric",)
 
 import numpy as np
 

rubin_sim/maf/maf_contrib/grb_transient_metric.py

@@ -1,4 +1,4 @@
-__all__ = ("GRBTransientMetric", )
+__all__ = ("GRBTransientMetric",)
 
 
 import numpy as np

rubin_sim/maf/maf_contrib/gw170817_det_metric.py

@@ -9,7 +9,7 @@
 
 from .transient_ascii_sed_metric import TransientAsciiSEDMetric
 
-__all__ = ("GW170817DetMetric", )
+__all__ = ("GW170817DetMetric",)
 base_path = Path(__file__).parent
 
 

rubin_sim/maf/maf_contrib/intervals_between_obs_metric.py

@@ -8,7 +8,7 @@
 # The difference between this metric and the VisitGapMetric metric is that VisitGapMetric calculates reduceFunc of gaps between observations of a data_slice throughout the whole
 # baseline, but IntervalsBetweenObsMetric calculates the gaps between observations during another survey observing window. This metric combined with surveys footprint
 # overlap can determine how many often another survey footprint is observed by LSST during specific time intervals.
-__all__ = ("IntervalsBetweenObsMetric", )
+__all__ = ("IntervalsBetweenObsMetric",)
 
 import numpy as np
 from astropy.time import Time

rubin_sim/maf/maf_contrib/lss_metrics.py

@@ -1,4 +1,4 @@
-__all__ = ("GalaxyCountsMetric", )
+__all__ = ("GalaxyCountsMetric",)
 
 import healpy as hp
 import numpy as np

rubin_sim/maf/maf_contrib/lss_obs_strategy/alm_plots.py

@@ -3,7 +3,7 @@
 #
 # Humna Awan: humna.awan@rutgers.edu
 #####################################################################################################
-__all__ = ("alm_plots", )
+__all__ = ("alm_plots",)
 
 import os
 
@@ -25,26 +25,34 @@ def alm_plots(
     show_plots=True,
 ):
     """
-
     Plot the skymaps/cartview plots corresponding to alms with specified l-ranges.
     Automatically creates the output directories and saves the plots.
 
     Parameters
-    -------------------
-      * path: str: path to the main directory where output directory is saved
-      * out_dir: str: name of the main output directory
-      * bundle: metricBundle object.
-      * nside: int: HEALpix resolution parameter. Default: 128
-      * lmax: int: upper limit on the multipole. Default: 500
-      * filterBand: str: any one of 'u', 'g', 'r', 'i', 'z', 'y'. Default: 'i'
-      * ra_range: float array: range of right ascention (in degrees) to consider in cartview plot; only useful when
+    ----------
+    path : `str`
+        path to the main directory where output directory is saved
+    out_dir : `str`
+        name of the main output directory
+    bundle : metricBundle
+    nside : `int`
+        HEALpix resolution parameter. Default: 128
+    lmax : `int`
+        upper limit on the multipole. Default: 500
+    filterband : `str`
+        any one of 'u', 'g', 'r', 'i', 'z', 'y'. Default: 'i'
+    ra_range : `np.ndarray`
+        range of right ascention (in degrees) to consider in cartview plot; only useful when
                               cartview= True. Default: [-50,50]
-      * dec_range: float array: range of declination (in degrees) to consider in cartview plot; only useful when
+    dec_range : `np.ndarray`
+        range of declination (in degrees) to consider in cartview plot; only useful when
                                cartview= True. Default: [-65,5]
-      * subsets_to_consider: array of int arrays: l-ranges to consider, e.g. use [[50, 100]] to consider 50<l<100.
+    subsets_to_consider : `np.ndarray`
+        l-ranges to consider, e.g. use [[50, 100]] to consider 50<l<100.
                                                 Currently built to handle five subsets (= number of colors built in).
                                                 Default: [[130,165], [240, 300]]
-      * show_plots: `bool`: set to True if want to show figures. Default: True
+    show_plots : `bool`
+        set to True if want to show figures. Default: True
 
     """
     # set up the output directory