rubin-sim 2.6.1.dev2__py3-none-any.whl

rubin_sim/skybrightness/twilight_func.py

@@ -0,0 +1,83 @@
+__all__ = ("twilight_func", "zenith_twilight", "simple_twi")
+
+import numpy as np
+
+
+def simple_twi(xdata, *args):
+    """
+    Fit a simple slope and constant to many healpixels
+
+    xdata should have keys:
+    sunAlt
+    hpid
+
+    args:
+    0: slope
+    1:hpid: magnitudes
+    hpid+1:2*hpid: constant offsets
+    """
+
+    args = np.array(args)
+    hpmax = np.max(xdata["hpid"])
+    result = args[xdata["hpid"] + 1] * np.exp(xdata["sunAlt"] * args[0]) + args[xdata["hpid"] + 2 + hpmax]
+    return result
+
+
+def twilight_func(xdata, *args, amCut=1.0):
+    """
+    xdata: numpy array with columns 'alt', 'az', 'sunAlt' all in radians.
+    az should be relative to the sun (i.e., sun is at az zero.
+
+    based on what I've seen, here's my guess for how to fit the twilight:
+    args[0] = ratio of (zenith twilight flux at sun_alt = -12) and dark sky
+    zenith flux
+    args[1] = decay slope for all pixels (mags/radian)
+    args[2] = airmass term for hemisphere away from the sun.
+    (factor to multiply max brightness at zenith by)
+    args[3] = az term for hemisphere towards sun
+    args[4] = zenith dark sky flux
+    args[5:] = zenith dark sky times constant (optional)
+
+    amCut : float (1.0)
+        The airmass cut to apply to use only the away from sun fit.
+        Was set to 1.1 previously for not very clear reasons.
+
+    """
+
+    args = np.array(args)
+    az = xdata["azRelSun"]
+    airmass = xdata["airmass"]
+    sun_alt = xdata["sunAlt"]
+    flux = np.zeros(az.size, dtype=float)
+    away = np.where((airmass <= amCut) | ((az >= np.pi / 2) & (az <= 3.0 * np.pi / 2)))
+    towards = np.where((airmass > amCut) & ((az < np.pi / 2) | (az > 3.0 * np.pi / 2)))
+
+    flux = args[0] * args[4] * 10.0 ** (args[1] * (sun_alt + np.radians(12.0)) + args[2] * (airmass - 1.0))
+    flux[towards] *= 10.0 ** (args[3] * np.cos(az[towards]) * (airmass[towards] - 1.0))
+
+    # This let's one fit the dark sky background simultaneously.
+    # It assumes the dark sky is a function of airmass only.
+    # Forced to be args[4] at zenith.
+    if np.size(args) >= 6:
+        flux[away] += args[4] * np.exp(args[5:][xdata["hpid"][away]] * (airmass[away] - 1.0))
+        flux[towards] += args[4] * np.exp(args[5:][xdata["hpid"][towards]] * (airmass[towards] - 1.0))
+
+    return flux
+
+
+def zenith_twilight(alpha, *args):
+    """
+    The flux at zenith as a linear combination of a twilight component
+    and a constant:
+    alpha = sun altitude (radians)
+    args[0] = ratio of (zenith twilight flux at sunAlt = -12) and
+    dark sky zenith flux
+    args[1] = decay slope for all pixels (mags/radian)
+    args[2] = airmass term for hemisphere away from the sun.
+    (factor to multiply max brightness at zenith by)
+    args[3] = az term for hemisphere towards sun
+    args[4] = zenith dark sky flux
+    """
+
+    flux = args[0] * args[4] * 10.0 ** (args[1] * (alpha + np.radians(12.0))) + args[4]
+    return flux

rubin_sim/skybrightness/utils.py

@@ -0,0 +1,91 @@
+__all__ = ("wrap_ra", "robust_rms", "recalc_mags")
+
+import glob
+import os
+
+import numpy as np
+from rubin_scheduler.data import get_data_dir
+
+from rubin_sim.phot_utils import Bandpass, Sed
+
+
+def wrap_ra(ra):
+    """
+    Wrap only RA values into 0-2pi (using mod).
+    """
+    ra = ra % (2.0 * np.pi)
+    return ra
+
+
+def robust_rms(array, missing=0.0):
+    """
+    Use the interquartile range to compute a robust approximation of the RMS.
+    if passed an array smaller than 2 elements, return missing value
+    """
+    if np.size(array) < 2:
+        rms = missing
+    else:
+        iqr = np.percentile(array, 75) - np.percentile(array, 25)
+        rms = iqr / 1.349  # approximation
+    return rms
+
+
+def spec2mags(spectra_list, wave):
+    """Convert sky spectra to magnitudes"""
+    # Load LSST filters
+    through_path = os.path.join(get_data_dir(), "throughputs/baseline")
+    keys = ["u", "g", "r", "i", "z", "y"]
+
+    dtype = [("mags", "float", (6))]
+    result = np.zeros(len(spectra_list), dtype=dtype)
+
+    filters = {}
+    for filtername in keys:
+        bp = np.loadtxt(
+            os.path.join(through_path, "total_" + filtername + ".dat"),
+            dtype=list(zip(["wave", "trans"], [float] * 2)),
+        )
+        temp_b = Bandpass()
+        temp_b.set_bandpass(bp["wave"], bp["trans"])
+        filters[filtername] = temp_b
+
+    filterwave = np.array([filters[f].calc_eff_wavelen()[0] for f in keys])
+
+    for i, spectrum in enumerate(spectra_list):
+        tempSed = Sed()
+        tempSed.set_sed(wave, flambda=spectrum)
+        for j, filtName in enumerate(keys):
+            try:
+                result["mags"][i][j] = tempSed.calc_mag(filters[filtName])
+            except ValueError:
+                pass
+    return result, filterwave
+
+
+def recalc_mags(data_dir=None):
+    """Recalculate the magnitudes for sky brightness components.
+
+    DANGER:  Overwrites data files in place. The rubin_sim_data/skybrightness
+    folder will need to be packaged and updated after running this to propagate
+    changes to other users.
+    """
+    dirs = ["Airglow", "MergedSpec", "ScatteredStarLight", "Zodiacal", "LowerAtm", "Moon", "UpperAtm"]
+
+    if data_dir is None:
+        data_dir = get_data_dir()
+
+    full_paths = [os.path.join(data_dir, "skybrightness/ESO_Spectra", dirname) for dirname in dirs]
+    for path in full_paths:
+        files = glob.glob(os.path.join(path, "*.npz"))
+        for filename in files:
+            data = np.load(filename)
+
+            spec = data["spec"].copy()
+            wave = data["wave"].copy()
+            data.close()
+            new_mags, filterwave = spec2mags(spec["spectra"], wave)
+            spec["mags"] = new_mags["mags"]
+
+            np.savez(filename, wave=wave, spec=spec, filterWave=filterwave)
+
+    pass

rubin_sim-2.6.1.dev2.dist-info/METADATA

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: rubin-sim
+Version: 2.6.1.dev2
+Summary: Scheduler, survey strategy analysis, and other simulation tools for Rubin Observatory.
+License: GPL
+Project-URL: documentation, https://rubin-sim.lsst.io
+Project-URL: repository, https://github.com/lsst/rubin_sim
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astroplan
+Requires-Dist: astropy
+Requires-Dist: colorcet
+Requires-Dist: cycler
+Requires-Dist: gitpython
+Requires-Dist: h5py
+Requires-Dist: healpy
+Requires-Dist: matplotlib
+Requires-Dist: numexpr
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: rubin-scheduler>=3.18
+Requires-Dist: scikit-learn
+Requires-Dist: scipy
+Requires-Dist: shapely
+Requires-Dist: skyfield>=1.52
+Requires-Dist: skyproj
+Requires-Dist: sqlalchemy
+Requires-Dist: tables
+Requires-Dist: tqdm
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: black>=25; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: isort; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: testing.postgresql; extra == "test"
+Provides-Extra: dev
+Requires-Dist: documenteer[guide]; extra == "dev"
+Provides-Extra: extras
+Requires-Dist: george; extra == "extras"
+Requires-Dist: pyoorb; extra == "extras"
+Dynamic: license-file
+
+# rubin_sim
+Scheduler, survey strategy analysis, and other simulation tools for Rubin Observatory.
+
+
+[![pypi](https://img.shields.io/pypi/v/rubin-sim.svg)](https://pypi.org/project/rubin-sim/)
+ [![Conda Version](https://img.shields.io/conda/vn/conda-forge/rubin-sim.svg)](https://anaconda.org/conda-forge/rubin-sim) <br>
+[![Run CI](https://github.com/lsst/rubin_sim/actions/workflows/test_and_build.yaml/badge.svg)](https://github.com/lsst/rubin_sim/actions/workflows/test_and_build.yaml)
+[![Build and Upload Docs](https://github.com/lsst/rubin_sim/actions/workflows/build_docs.yaml/badge.svg)](https://github.com/lsst/rubin_sim/actions/workflows/build_docs.yaml)
+[![codecov](https://codecov.io/gh/lsst/rubin_sim/branch/main/graph/badge.svg?token=2BUBL8R9RH)](https://codecov.io/gh/lsst/rubin_sim)
+
+
+[![DOI](https://zenodo.org/badge/365031715.svg)](https://zenodo.org/badge/latestdoi/365031715)
+
+
+## rubin_sim ## 
+
+The [Legacy Survey of Space and Time](http://www.lsst.org) (LSST)
+is anticipated to encompass around 2 million observations spanning a decade,
+averaging 800 visits per night. The `rubin_sim` package was built to help
+understand the predicted performance of the LSST.
+
+The `rubin_sim` package contains the following main modules: 
+* `phot_utils` - provides synthetic photometry
+using provided throughput curves based on current predicted performance.
+* `skybrightness` incorporates the ESO
+sky model, modified to match measured sky conditions at the LSST site,
+including an addition of a model for twilight skybrightness. This is used
+to generate the pre-calculated skybrightness data used in
+[`rubin_scheduler.skybrightness_pre`](https://rubin-scheduler.lsst.io/skybrightness-pre.html).
+* `moving_objects` provides a way to generate
+synthetic observations of moving objects, based on how they would appear in
+pointing databases ("opsims") created by
+[`rubin_scheduler`](https://rubin-scheduler.lsst.io).
+* `maf` the Metrics Analysis Framework, enabling efficient and
+scientifically varied evaluation of the LSST survey strategy and progress
+by providing a framework to enable these metrics to run in a
+standardized way on opsim outputs.
+
+More documentation for `rubin_sim` is available at 
+[https://rubin-sim.lsst.io](https://rubin-sim.lsst.io), including installation instructions. 
+
+### Getting Help ###
+
+Questions about `rubin_sim` can be posted on the [sims slack channel](https://lsstc.slack.com/archives/C2LQ5JW9W), or on https://community.lsst.org/c/sci/survey_strategy/ (optionally, tag @yoachim and/or @ljones so we get notifications about it).