PyDIET 0.9.3__py3-none-any.whl

pydiet/__init__.py

@@ -0,0 +1,12 @@
+"""
+PyDIET
+======
+
+[CFHT](https://www.cfht.hawaii.edu)'s new Direct Imaging Exposure Time calculator.
+"""
+# Copyright CFHT/CNRS
+# Licensed under the MIT license
+
+from .api_client.client import Client
+from .server.models import ETCQueryModel, ETCResponseModel
+

pydiet/api_client/__init__.py

@@ -0,0 +1,6 @@
+"""
+PyDIET API client subpackage
+"""
+# Copyright (c) 2024 - 2026 DAp/CEA/AIM/OSUPS/UParisSaclay
+# Licensed under the MIT licence
+

pydiet/api_client/client.py

@@ -0,0 +1,57 @@
+#! /usr/bin/python3
+"""
+Python client functions for harvesting results from the PyDIET ETC
+"""
+# Copyright (c) 2024 - 2026 CFHT/CNRS/CEA-AIM/OSUPS-UParisSaclay
+# Licensed under the MIT licence
+
+from typing import Optional
+
+import httpx
+from pydantic import ValidationError
+
+from ..server.models.query import ETCQueryModel
+from ..server.models.response import ETCResponseModel
+from ..server.config import settings
+
+
+class Client:
+    def __init__(self, api_url: Optional[str]=None) -> None:
+        self.api_url = f"http://{settings['host']}" \
+            f":{settings['port']}{settings['api_path']}" if api_url is None \
+            else api_url
+
+
+    def query(
+            self,
+            query: ETCQueryModel,
+            timeout: float=10.) -> ETCResponseModel:
+        headers: dict[str, str] = {"Accept": "application/json"}
+        print(f"{self.api_url}/{query.instrument.value}")
+        try:
+            with httpx.Client(timeout=timeout, headers=headers) as client:
+                response = client.get(
+                    f"{self.api_url}/{query.instrument.value}",
+                    params=query.model_dump(
+                        exclude={"instrument"},
+                        exclude_none=True,
+                        mode="json"
+                    )
+                )
+                response.raise_for_status()
+                payload = response.json()
+        except httpx.HTTPStatusError as exc:
+            raise RuntimeError(
+                f"HTTP error {exc.response.status_code}: {exc.response.text}"
+            ) from exc
+        except httpx.HTTPError as exc:
+            raise RuntimeError(f"Transport error: {exc}") from exc
+        except ValueError as exc:
+            raise RuntimeError("Response was not valid JSON") from exc
+
+        try:
+            return ETCResponseModel.model_validate(payload)
+        except ValidationError as exc:
+            raise RuntimeError(f"Invalid response schema: {exc}") from exc
+
+

pydiet/cmd/__init__.py

@@ -0,0 +1,9 @@
+"""
+PyDIET
+======
+
+[CFHT](https://www.cfht.hawaii.edu)'s new Direct Imaging Exposure Time calculator.
+"""
+# Copyright CFHT/CNRS
+# Licensed under the MIT license
+

pydiet/cmd/start.py

@@ -0,0 +1,107 @@
+#! /usr/bin/python3
+"""
+Start script (renamed as :program:`pydiet`).
+"""
+# Copyright CFHT/CNRS/CEA/UParisSaclay
+# Licensed under the MIT licence
+from sys import exit
+from threading import Thread
+from time import sleep
+from urllib.request import urlopen
+from urllib.error import URLError
+import webbrowser
+
+from uvicorn import run
+
+from pydiet.server import config
+
+
+def start_server(
+        app: str="pydiet.server.app:create_app",
+        host: str="localhost",
+        port: int=8009,
+        root_path: str="",
+        workers: int=4,
+        access_log: bool=False,
+        reload: bool=True
+    ):
+    """
+    Start the Uvicorn server in application factory mode.
+    
+    Parameters
+    ----------
+    app: str, optional
+        Name of the ASGI app callable.
+    host: str, optional
+        Host name or IP address.
+    port: int, optional
+        Port.
+    root_path: str | ~pathlib.Path, optional
+        ASGI root_path.
+    workers: int, optional
+        Number of workers.
+    access_log: bool, optional
+        Display access log.
+    reload: bool, optional
+        Enable auto-reload (turns off multiple workers).
+    """
+    run(
+        app,
+        host=host,
+        port=port,
+        root_path=root_path,
+        access_log=access_log,
+        workers=workers,
+        reload=reload,
+        factory=True
+    )
+    return
+
+
+def open_browser_when_ready(host: str, port: int, root_path: str, api_path: str):
+    """
+    Start a browser session once the server is up and running.
+    """
+    link =  f"http://{host}:{port}{root_path or ''}"
+    f"{config.settings['root_path'] or ''}"
+    while True:
+        try:
+            # succeeds only when server is actually up
+            urlopen(f"{link}{api_path}/health", timeout=2)
+            break
+        except URLError:
+            sleep(0.5)
+    webbrowser.open(link)
+
+
+def main() -> int:
+    """
+    Set up configuration and start the PyDIET server.
+    """
+    if config.settings["browser"]:
+        # Start watcher thread to open browser when server is ready
+        Thread(
+            target=open_browser_when_ready,
+            args=(
+                config.settings["host"],
+                config.settings["port"],
+                config.settings["root_path"],
+                config.settings["api_path"]
+            ),
+            daemon=True,
+        ).start()
+
+    # Start the server itself
+    start_server(
+        host=config.settings["host"],
+        port=config.settings["port"],
+        root_path=config.settings["root_path"],
+        access_log=config.settings["access_log"],
+        reload=config.settings["reload"],
+        workers=config.settings["workers"]
+    )
+    return 0
+
+if __name__ == "__main__":
+    exit(main())
+

pydiet/data/data_config.toml

@@ -0,0 +1,242 @@
+#
+# Data configuration for PyDIET
+#
+# The format is TOML (https://toml.io)
+# Numerical quantities must be written as strings and support physical units
+
+# Parent path for all data files
+path = "data"
+
+####################### Table array of observatory sites ######################
+
+[[sites]]
+default = true
+id = 'mko'
+name = "Mauna Kea Observatories"
+description = "Mauna Kea Observatories, Hawaii, USA"
+altitude = "4205 m"
+path = "sites/mko"
+[sites.transmission]
+# Atmospheric transmission at Mauna Kea Observatories at various airmasses:
+# - Computed by E.Bertin (2025) using MODTRAN6, using the default "tropical"
+#   atmosphere and the "rural" aerosol model settings.
+# -  Pointing upward from an altitude of 4204m.
+# -  CO2 concentration set to 430ppm.
+path = "transmission"
+files = [
+    { vars = {am = 1.0}, file = "MKO_transmission.AM1.0.fits", default=true },
+    { vars = {am = 1.1}, file = "MKO_transmission.AM1.1.fits" },
+    { vars = {am = 1.2}, file = "MKO_transmission.AM1.2.fits" },
+    { vars = {am = 1.3}, file = "MKO_transmission.AM1.3.fits" },
+    { vars = {am = 1.4}, file = "MKO_transmission.AM1.4.fits" },
+    { vars = {am = 1.5}, file = "MKO_transmission.AM1.5.fits" },
+    { vars = {am = 1.6}, file = "MKO_transmission.AM1.6.fits" },
+    { vars = {am = 1.7}, file = "MKO_transmission.AM1.7.fits" },
+    { vars = {am = 1.8}, file = "MKO_transmission.AM1.8.fits" },
+    { vars = {am = 1.9}, file = "MKO_transmission.AM1.9.fits" },
+    { vars = {am = 2.0}, file = "MKO_transmission.AM2.0.fits" },
+    { vars = {am = 2.5}, file = "MKO_transmission.AM2.5.fits" },
+    { vars = {am = 3.0}, file = "MKO_transmission.AM3.0.fits" },
+    { vars = {am = 3.5}, file = "MKO_transmission.AM3.5.fits" },
+    { vars = {am = 4.0}, file = "MKO_transmission.AM4.0.fits" },
+    { vars = {am = 4.5}, file = "MKO_transmission.AM4.5.fits" },
+    { vars = {am = 5.0}, file = "MKO_transmission.AM5.0.fits" }
+]
+[sites.emission]
+# Sky emission models
+path = "emission"
+files = [
+# ESO SkyCalc sky emission model computed with default settings
+# (except for the Moon set at -90 deg elevation).
+    { vars = {sky='dark', am=1.0}, file = "MKO_emission.dark.AM1.0.fits", default=true },
+    { vars = {sky='dark', am=1.1}, file = "MKO_emission.dark.AM1.1.fits" },
+    { vars = {sky='dark', am=1.2}, file = "MKO_emission.dark.AM1.2.fits" },
+    { vars = {sky='dark', am=1.3}, file = "MKO_emission.dark.AM1.3.fits" },
+    { vars = {sky='dark', am=1.4}, file = "MKO_emission.dark.AM1.4.fits" },
+    { vars = {sky='dark', am=1.5}, file = "MKO_emission.dark.AM1.5.fits" },
+    { vars = {sky='dark', am=1.6}, file = "MKO_emission.dark.AM1.6.fits" },
+    { vars = {sky='dark', am=1.7}, file = "MKO_emission.dark.AM1.7.fits" },
+    { vars = {sky='dark', am=1.8}, file = "MKO_emission.dark.AM1.8.fits" },
+    { vars = {sky='dark', am=1.9}, file = "MKO_emission.dark.AM1.9.fits" },
+    { vars = {sky='dark', am=2.0}, file = "MKO_emission.dark.AM2.0.fits" },
+    { vars = {sky='dark', am=2.5}, file = "MKO_emission.dark.AM2.5.fits" },
+    { vars = {sky='dark', am=3.0}, file = "MKO_emission.dark.AM3.0.fits" },
+# ESO SkyCalc sky emission model with 30% Moon component
+# (66.4 deg phase at 45 deg elevation and 45 deg distance).
+    { vars = {sky='grey', am=1.0}, file = "MKO_emission.grey.AM1.0.fits" },
+    { vars = {sky='grey', am=1.1}, file = "MKO_emission.grey.AM1.1.fits" },
+    { vars = {sky='grey', am=1.2}, file = "MKO_emission.grey.AM1.2.fits" },
+    { vars = {sky='grey', am=1.3}, file = "MKO_emission.grey.AM1.3.fits" },
+    { vars = {sky='grey', am=1.4}, file = "MKO_emission.grey.AM1.4.fits" },
+    { vars = {sky='grey', am=1.5}, file = "MKO_emission.grey.AM1.5.fits" },
+    { vars = {sky='grey', am=1.6}, file = "MKO_emission.grey.AM1.6.fits" },
+    { vars = {sky='grey', am=1.7}, file = "MKO_emission.grey.AM1.7.fits" },
+    { vars = {sky='grey', am=1.8}, file = "MKO_emission.grey.AM1.8.fits" },
+    { vars = {sky='grey', am=1.9}, file = "MKO_emission.grey.AM1.9.fits" },
+    { vars = {sky='grey', am=2.0}, file = "MKO_emission.grey.AM2.0.fits" },
+    { vars = {sky='grey', am=2.5}, file = "MKO_emission.grey.AM2.5.fits" },
+    { vars = {sky='grey', am=3.0}, file = "MKO_emission.grey.AM3.0.fits" },
+# ESO SkyCalc sky emission model with 60% Moon component 
+# (101.5 deg phase, at 45 deg elevation and 45 deg distance).
+    { vars = {sky='bright', am=1.0}, file = "MKO_emission.bright.AM1.0.fits", default=true },
+    { vars = {sky='bright', am=1.1}, file = "MKO_emission.bright.AM1.1.fits" },
+    { vars = {sky='bright', am=1.2}, file = "MKO_emission.bright.AM1.2.fits" },
+    { vars = {sky='bright', am=1.3}, file = "MKO_emission.bright.AM1.3.fits" },
+    { vars = {sky='bright', am=1.4}, file = "MKO_emission.bright.AM1.4.fits" },
+    { vars = {sky='bright', am=1.5}, file = "MKO_emission.bright.AM1.5.fits" },
+    { vars = {sky='bright', am=1.6}, file = "MKO_emission.bright.AM1.6.fits" },
+    { vars = {sky='bright', am=1.7}, file = "MKO_emission.bright.AM1.7.fits" },
+    { vars = {sky='bright', am=1.8}, file = "MKO_emission.bright.AM1.8.fits" },
+    { vars = {sky='bright', am=1.9}, file = "MKO_emission.bright.AM1.9.fits" },
+    { vars = {sky='bright', am=2.0}, file = "MKO_emission.bright.AM2.0.fits" },
+    { vars = {sky='bright', am=2.5}, file = "MKO_emission.bright.AM2.5.fits" },
+    { vars = {sky='bright', am=3.0}, file = "MKO_emission.bright.AM3.0.fits" }
+]
+
+
+######################### Table array of telescopes ###########################
+
+[[telescopes]]
+default = true
+id = 'cfht'
+name = "CFHT"
+description = "Canada-France-Hawaii 3.6m telescope"
+path = "telescopes/cfht"
+# Full collecting area _including_ possible mirror hole and spider branches
+collecting_area = "10.134 m2" # from CFHT's observatory manual: 3.592m diameter
+# Default obstruction area (only used if not specified for the instrument)
+obstruction_area = "0.974 m2" # 0.951m diameter hole and 4x5cm spider branches
+[telescopes.transmission]
+# Transmission curves for the CFHT 3.6m telescope
+path = "transmission"
+files = [ {file = "CFHT_M1_transmission.fits"} ]
+[telescopes.emission]
+# Emission curves for the CFHT 3.6m telescope
+temperatures = ["273 K"]
+
+
+########################## Table array of instruments #########################
+
+[[instruments]]
+# MegaCam/MegaPrime instrument. All infos derived from the MegaCam web pages at
+# https://www.cfht.hawaii.edu/Instruments/Imaging/Megacam/index.html
+default = true
+id = 'megacam'
+name = "MegaCam"
+description = "The MegaPrime/MegaCam instrument"
+path = "instruments/megacam"
+wavelength_range = "[250., 1050.] nm"
+obstruction_area = "2.112 m2" # Forged by subtracting 
+overhead = "40 s"
+site_id = 'mko'
+telescope_id = 'cfht'
+[instruments.optics]
+# MegaPrime/MegaCam optical properties
+path = "optics"
+[instruments.optics.transmission]
+# Transmission as a function of wavelength for all MegaPrime optical components
+path = "transmission"
+files = [ {file = "MegaPrime_transmission.fits"} ]
+[instruments.optics.emission]
+# Emission as a function of wavelength for all MegaPrime optical components
+temperatures = ["273 K"] # Typical temperature of the corrector optics
+[instruments.filters]
+path = "filters"
+[instruments.filters.transmission]
+vars = ['id']
+files = [
+    {id = 'u', name = "u", file = "u.MP9302.fits"},
+    {id = 'g', name = "g", file = "g.MP9402.fits"},
+    {id = 'r', name = "r", file = "r.MP9602.fits", default=true},
+    {id = 'i', name = "i", file = "i.MP9703.fits"},
+    {id = 'z', name = "z", file = "z.MP9901.fits"},
+    {id = 'gri', name = "gri", file = "gri.MP9605.fits"},
+    {id = 'cahk', name = "CaHK", file = "CaHK.MP9303.fits"},
+    {id = 'oiii', name = "OIII", file = "OIII.MP9501.fits"},
+    {id = 'oiiioff', name = "OIII off", file = "OIIIOFF.MP9502.fits"},
+    {id = 'ha', name = "Ha", file = "Ha.MP9603.fits"},
+    {id = 'haoff', name = "Ha off", file = "HaOFF.MP9604.fits"},
+    {id = 'm4112', name = "M4112", file = "M4112.MP9403.fits"},
+    {id = 'm4376', name = "M4376", file = "M4376.MP9404.fits"}
+]
+[instruments.filters.emission]
+# Emission as a function of wavelength for all MegaPrime optical components
+temperatures = ["273 K"] # Typical temperature of the corrector optics
+[instruments.detector]
+# Average MegaCam E2V CCD characteristics
+path = "detector"
+gain = "1.62 electron/adu"
+ron = "5. electron"
+scale = "[0.186, 0.186] arcsec/pix"
+full_well = "240000 electron"
+range = "65536 adu"
+bias = "1200. adu"
+[instruments.detector.transmission]
+path = "qe"
+# Average MegaCam CCD quantum efficiency as a function of wavelength
+files = [ {file = "MegaCam_QE.average.fits"} ]
+[instruments.detector.emission]
+temperatures = ["153 K"]
+
+
+[[instruments]]
+# WIRCam instrument. Most infos derived from the WIRCam web pages at
+# https://www.cfht.hawaii.edu/Instruments/Imaging/WIRCam/
+id = 'wircam'
+name = "WIRCam"
+description = "The WIRCam instrument"
+path = "instruments/wircam"
+wavelength_range = "[900., 2600.] nm"
+obstruction_area = "1.734 m2" # Forged by subtracting 8.4m2 from 10.134 m2
+overhead = "10. s"
+site_id = 'mko'
+telescope_id = 'cfht'
+[instruments.optics]
+# WIRCam optical properties
+path = "optics"
+[instruments.optics.transmission]
+# Transmission as a function of wavelength for all WIRCam optical components
+path = "transmission"
+files = [ {file = "WIRCam_transmission.fits"} ]
+[instruments.optics.emission]
+# Emission as a function of wavelength for all WIRCam optical components
+temperatures = ["273 K"]
+[instruments.filters]
+path = "filters"
+[instruments.filters.transmission]
+vars = ['id']
+files = [
+    {id = 'y', name = "Y", file = "Y.WC8002.fits", default=true},
+    {id = 'j', name = "J", file = "J.WC8103.fits"},
+    {id = 'h', name = "H", file = "H.WC8202.fits"},
+    {id = 'ks', name = "Ks", file = "Ks.WC8302.fits"},
+    {id = 'h2', name = "H2 (1-0)", file = "H2.WC8304.fits"},
+    {id = 'lowoh1', name = "Low OH1", file = "LowOH1.WC8104.fits"},
+    {id = 'lowoh2', name = "Low OH2", file = "LowOH2.WC8102.fits"},
+    {id = 'ch4on', name = "CH4 on", file = "CH4On.WC8203.fits"},
+    {id = 'ch4off', name = "CH4 off", file = "CH4Off.WC8204.fits"},
+    {id = 'kcont', name = "K cont.", file = "Kcont.WC8303.fits"},
+    {id = 'brg', name = "Br.gamma", file = "BrG.WC8305.fits"},
+    {id = 'w', name = "W", file = "W.WC8105.fits"}
+]
+[instruments.filters.emission]
+temperatures = ["80 K"]
+[instruments.detector]
+# Average WIRCam Hawaii-2RG CMOS characteristics
+gain = "3.7 electron/adu"
+ron = "30. electron"
+scale = "[0.306, 0.306] arcsec/pix"
+path = "detector"
+full_well = "130000 electron"
+range = "65536 adu"
+bias = "0. adu"
+[instruments.detector.transmission]
+path = "qe"
+# Average Hawaii-2RG quantum efficiency as a function of wavelength from the
+# science-grade sample of Finger+2006, which has a 2.5 μm cut-off; see
+# https://info.cfht.hawaii.edu/display/~bertin/WIRCam+quantum+efficiency+curve
+files = [ {file = "WIRCam_QE.average.fits"} ]
+[instruments.detector.emission]
+temperatures = ["80 K"]
+
+

pydiet/data/description.txt

@@ -0,0 +1 @@
+Root folder for PyDIET data.

pydiet/data/instruments/description.txt

@@ -0,0 +1 @@
+Instrument data.

pydiet/data/instruments/megacam/description.txt

@@ -0,0 +1 @@
+The MegaPrime/MegaCam instrument.

pydiet/data/instruments/megacam/detector/description.txt

@@ -0,0 +1 @@
+MegaCam CCD and readout electronics properties.

pydiet/data/instruments/megacam/detector/qe/description.txt

@@ -0,0 +1,2 @@
+Average MegaCam CCD quantum efficiency as a function of wavelength.
+

pydiet/data/instruments/megacam/filters/description.txt

@@ -0,0 +1 @@
+MegaPrime/MegaCam filter set.

pydiet/data/instruments/megacam/optics/description.txt

@@ -0,0 +1,2 @@
+MegaPrime/MegaCam optical properties.
+

pydiet/data/instruments/megacam/optics/transmission/description.txt

@@ -0,0 +1,2 @@
+Transmission curve of the MegaPrime/MegaCam optics (wide-field corrector + camera window).
+

pydiet/data/instruments/wircam/description.txt

@@ -0,0 +1 @@
+The WIRCam camera.

pydiet/data/instruments/wircam/detector/description.txt

@@ -0,0 +1 @@
+WIRCam detector and readout electronics properties.

pydiet/data/instruments/wircam/detector/qe/description.txt

@@ -0,0 +1,2 @@
+Average Hawaii-2RG (with 2.5 micron cutoff) quantum efficiency as a function of wavelength, from Finger et al. 2006.
+

pydiet/data/instruments/wircam/filters/description.txt

@@ -0,0 +1 @@
+WIRCam filter set.

pydiet/data/instruments/wircam/optics/description.txt

@@ -0,0 +1,2 @@
+MegaPrime/MegaCam optical properties.
+

pydiet/data/instruments/wircam/optics/transmission/description.txt

@@ -0,0 +1,2 @@
+Transmission curve of the WIRCam optics, excluding the tip-tilt plate.
+

pydiet/data/sites/description.txt

@@ -0,0 +1 @@
+Observation site data.

pydiet/data/sites/mko/description.txt

@@ -0,0 +1,2 @@
+Mauna Kea Observatories (4205m), Hawaii, USA.
+