PyDIET 0.9.3__tar.gz

pydiet-0.9.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Emmanuel Bertin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pydiet-0.9.3/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.1
+Name: PyDIET
+Version: 0.9.3
+Summary: CFHT's Direct Imaging Exposure Time calculator (DIET)
+Keywords: astronomy,CFHT,imaging
+Author-Email: Emmanuel Bertin <bertin@cfht.hawaii.edu>
+License: MIT License
+         
+         Copyright (c) 2024 Emmanuel Bertin
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Project-URL: Repository, https://github.com/astromatic/pydiet
+Project-URL: Homepage, https://www.cfht.hawaii.edu
+Project-URL: Documentation, https://astromatic.github.io/pydiet
+Requires-Python: >=3.10
+Requires-Dist: astropy>=5.0
+Requires-Dist: backports.strenum
+Requires-Dist: fastapi>=0.74
+Requires-Dist: httpx<0.29,>=0.28
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: numpy<2.0
+Requires-Dist: pillow>=11.0
+Requires-Dist: platformdirs>=3.4.0
+Requires-Dist: pydantic>=2.2
+Requires-Dist: pydantic-settings>=2.2
+Requires-Dist: python-multipart
+Requires-Dist: scipy>=1.15
+Requires-Dist: setuptools
+Requires-Dist: specutils>=1.18.0
+Requires-Dist: synphot>=1.5.0
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Requires-Dist: uvicorn[standard]>=0.30
+Provides-Extra: test
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: doc
+Requires-Dist: autodoc_pydantic>=2.2.0; extra == "doc"
+Requires-Dist: sphinx>=7.0; extra == "doc"
+Requires-Dist: sphinx-rtd-theme>=1.2; extra == "doc"
+Requires-Dist: sphinxcontrib-bibtex>=2.4.0; extra == "doc"
+Requires-Dist: sphinx-js>=3.2.2; extra == "doc"
+Description-Content-Type: text/markdown
+
+# PyDIET
+
+[![Documentation](https://github.com/astromatic/pydiet/actions/workflows/doc.yml/badge.svg)](https://astromatic.github.io/pydiet/)
+[![Tests](https://github.com/astromatic/pydiet/actions/workflows/tests.yml/badge.svg)](https://github.com/astromatic/pydiet/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/astromatic/pydiet/graph/badge.svg?token=t3ZeGLnWTD)](https://codecov.io/gh/astromatic/pydiet)
+
+PyDIET is [CFHT](https://www.cfht.hawaii.edu)'s new [Direct Imaging Exposure Time calculator](https://pydiet.cfht.hawaii.edu).
+
+<p>
+  <img src="https://github.com/astromatic/pydiet/blob/main/docs/src/figures/pydiet.jpg" alt="Screenshot" width="640"/>
+</p>
+
+## Important
+PyDIET is still in testing phase.
+The authors reserve the right to modify, update, or discontinue any aspect of the package at any time without notice.
+This includes, but is not limited to, changes in instrument models, calibration data, algorithms, or implementation details, which may result in differences in the outputs produced by PyDIET over time.
+
+The authors shall not be liable for any direct, indirect, incidental, consequential, or special damages arising out of or in connection with the use of, or inability to use PyDIET including but not limited to errors in calculations, scientific results, or observational planning.
+
+## Installing
+
+### pip/pipx
+
+```
+git clone https://github.com/astromatic/pydiet
+cd pydiet
+pip install .
+```
+
+### Docker
+To build a Dockerfile for installing pyDiet:
+```
+docker build -t pydiet:latest -f docker/Dockerfile .
+```
+Run, get a shell, and python venv
+```
+docker run -tid --name pydiet pydiet
+docker exec -ti pydiet "/bin/bash"
+source venv_pydiet/bin/activate
+```
+## Executing (locally)
+
+```
+pydiet -b
+```
+
+## Customizing
+PyDIET can easily be adapted to other astronomical imagers by simply editing the [``data/data_config.toml``](https://github.com/astromatic/pydiet/blob/main/src/pydiet/data/data_config.toml) file in [TOML](https://toml.io) format, and supplying [pysynphot-compliant](https://pysynphot.readthedocs.io/en/latest/using_pysynphot.html#pysynphot-io) transmission/emission [FITS](https://en.wikipedia.org/wiki/FITS) files for the various parts of the instrument chain.
+Use the provided [``utils/extract_filter.py`` script](https://github.com/astromatic/pydiet/blob/main/utils/extract_filter.py) to convert ASCII tables to pysynphot-compliant FITS format.
+
+The web interface can easily be customized to accomodate one or several instruments through query form and result display [templates](https://github.com/astromatic/pydiet/tree/main/src/pydiet/templates).
+

pydiet-0.9.3/README.md

@@ -0,0 +1,52 @@
+# PyDIET
+
+[![Documentation](https://github.com/astromatic/pydiet/actions/workflows/doc.yml/badge.svg)](https://astromatic.github.io/pydiet/)
+[![Tests](https://github.com/astromatic/pydiet/actions/workflows/tests.yml/badge.svg)](https://github.com/astromatic/pydiet/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/astromatic/pydiet/graph/badge.svg?token=t3ZeGLnWTD)](https://codecov.io/gh/astromatic/pydiet)
+
+PyDIET is [CFHT](https://www.cfht.hawaii.edu)'s new [Direct Imaging Exposure Time calculator](https://pydiet.cfht.hawaii.edu).
+
+<p>
+  <img src="https://github.com/astromatic/pydiet/blob/main/docs/src/figures/pydiet.jpg" alt="Screenshot" width="640"/>
+</p>
+
+## Important
+PyDIET is still in testing phase.
+The authors reserve the right to modify, update, or discontinue any aspect of the package at any time without notice.
+This includes, but is not limited to, changes in instrument models, calibration data, algorithms, or implementation details, which may result in differences in the outputs produced by PyDIET over time.
+
+The authors shall not be liable for any direct, indirect, incidental, consequential, or special damages arising out of or in connection with the use of, or inability to use PyDIET including but not limited to errors in calculations, scientific results, or observational planning.
+
+## Installing
+
+### pip/pipx
+
+```
+git clone https://github.com/astromatic/pydiet
+cd pydiet
+pip install .
+```
+
+### Docker
+To build a Dockerfile for installing pyDiet:
+```
+docker build -t pydiet:latest -f docker/Dockerfile .
+```
+Run, get a shell, and python venv
+```
+docker run -tid --name pydiet pydiet
+docker exec -ti pydiet "/bin/bash"
+source venv_pydiet/bin/activate
+```
+## Executing (locally)
+
+```
+pydiet -b
+```
+
+## Customizing
+PyDIET can easily be adapted to other astronomical imagers by simply editing the [``data/data_config.toml``](https://github.com/astromatic/pydiet/blob/main/src/pydiet/data/data_config.toml) file in [TOML](https://toml.io) format, and supplying [pysynphot-compliant](https://pysynphot.readthedocs.io/en/latest/using_pysynphot.html#pysynphot-io) transmission/emission [FITS](https://en.wikipedia.org/wiki/FITS) files for the various parts of the instrument chain.
+Use the provided [``utils/extract_filter.py`` script](https://github.com/astromatic/pydiet/blob/main/utils/extract_filter.py) to convert ASCII tables to pysynphot-compliant FITS format.
+
+The web interface can easily be customized to accomodate one or several instruments through query form and result display [templates](https://github.com/astromatic/pydiet/tree/main/src/pydiet/templates).
+

pydiet-0.9.3/pyproject.toml

@@ -0,0 +1,119 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "PyDIET"
+version = "0.9.3"
+description = "CFHT's Direct Imaging Exposure Time calculator (DIET)"
+authors = [
+    { name = "Emmanuel Bertin", email = "bertin@cfht.hawaii.edu" },
+]
+keywords = [
+    "astronomy",
+    "CFHT",
+    "imaging",
+]
+readme = "README.md"
+dependencies = [
+    "astropy >= 5.0",
+    "backports.strenum",
+    "fastapi >= 0.74",
+    "httpx >=0.28,<0.29",
+    "jinja2 >= 3.1.2",
+    "numpy < 2.0",
+    "pillow >= 11.0",
+    "platformdirs >= 3.4.0",
+    "pydantic >= 2.2",
+    "pydantic-settings >= 2.2",
+    "python-multipart",
+    "scipy >= 1.15",
+    "setuptools",
+    "specutils >= 1.18.0",
+    "synphot >= 1.5.0",
+    "tomli >= 1.1.0 ; python_version < '3.11'",
+    "uvicorn[standard] >= 0.30",
+]
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+[project.license]
+file = "LICENSE"
+
+[project.optional-dependencies]
+test = [
+    "mypy",
+    "pytest-cov",
+]
+doc = [
+    "autodoc_pydantic >= 2.2.0",
+    "sphinx >= 7.0",
+    "sphinx-rtd-theme >= 1.2",
+    "sphinxcontrib-bibtex >= 2.4.0",
+    "sphinx-js >= 3.2.2",
+]
+
+[project.scripts]
+pydiet = "pydiet.cmd.start:main"
+
+[project.urls]
+Repository = "https://github.com/astromatic/pydiet"
+Homepage = "https://www.cfht.hawaii.edu"
+Documentation = "https://astromatic.github.io/pydiet"
+
+[tool.pdm.build]
+excludes = [
+    "src/pydiet/web_client/node_modules",
+    "src/pydiet/doc/doctrees",
+]
+
+[tool.pdm.scripts]
+mypy = "mypy src"
+
+[tool.pdm.scripts.doc]
+cmd = "make inline"
+working_dir = "docs"
+
+[tool.pdm.scripts.pre_build]
+composite = [
+    "doc",
+    "mypy",
+]
+
+[tool.pdm.scripts.pre_install]
+composite = [
+    "doc",
+    "mypy",
+]
+
+[tool.mypy]
+exclude = [
+    "docs",
+    "tests",
+]
+
+[tool.pytest.ini_options]
+norecursedirs = [
+    "src/pydiet/web_client",
+]
+addopts = "--doctest-modules --doctest-continue-on-failure"
+doctest_optionflags = "NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS"
+filterwarnings = [
+    "ignore::DeprecationWarning",
+]
+tmp_path_retention_policy = "none"
+
+[tool.coverage.run]
+source_pkgs = [
+    "pydiet",
+]
+command_line = "-m pytest tests"

pydiet-0.9.3/src/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-0.9.3/src/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-0.9.3/src/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-0.9.3/src/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-0.9.3/src/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())
+