axsdb 0.0.2__tar.gz

axsdb-0.0.2/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/.github/workflows"
+    schedule:
+      interval: "monthly"

axsdb-0.0.2/.github/workflows/ci.yml

@@ -0,0 +1,98 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+      - main
+
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+
+jobs:
+  tests:
+    if: ${{ !github.event.pull_request.draft }}
+    name: Tests
+
+    strategy:
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+        os:
+          - ubuntu-latest
+          # - macOS-latest
+          # - windows-latest
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Pin active Python
+        run: uv python pin ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run Tests
+        run: uv run coverage run -m pytest
+
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-data-${{ matrix.python-version }}
+          path: .coverage.*
+          include-hidden-files: true
+          if-no-files-found: ignore
+
+  coverage:
+    if: ${{ !github.event.pull_request.draft }}
+    name: Combine coverage
+    runs-on: ubuntu-latest
+    needs: tests
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          # Use latest, so it understands all syntax.
+          python-version: "3.13"
+
+      - run: python -m pip install --upgrade coverage[toml]
+
+      - name: Download coverage data
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-data-*
+          merge-multiple: true
+
+      - name: Combine coverage
+        run: |
+          python -m coverage combine
+          python -m coverage html --skip-covered --skip-empty
+          python -m coverage json
+
+          TOTAL=$(python -c "import json;print(json.load(open('reports/coverage/coverage.json'))['totals']['percent_covered_display'])")
+          REPORT=$(python -m coverage report)
+
+          echo "### Total coverage: ${TOTAL}%" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          echo "${REPORT}" >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+
+      - name: Upload HTML report
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: reports/coverage/html

axsdb-0.0.2/.github/workflows/release.yml

@@ -0,0 +1,103 @@
+name: Publish Python distribution to PyPI
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build-wheels:
+    name: Build wheels
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get current git tag
+        id: tag
+        run: |
+          TAG=$(git describe --tags --abbrev=0)
+          # Remove the leading 'v' from the tag (e.g., 'v1.2.3' -> '1.2.3')
+          GIT_VERSION=${TAG#v}
+          echo "Current git tag version: $GIT_VERSION"
+          echo "::set-output name=tag::$GIT_VERSION"
+
+      - name: Check if git tag matches version
+        run: |
+          # Extract version from pyproject.toml
+          PY_VERSION=$(grep '^version = "' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          echo "Version from pyproject.toml: $PY_VERSION"
+          if [ "$PY_VERSION" != "${{ steps.tag.outputs.tag }}" ]; then
+            echo "Git tag does not match version in pyproject.toml."
+            exit 1
+          else
+            echo "Git tag matches version in pyproject.toml."
+          fi
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build wheels
+        run: |
+          uv build
+
+      - name: Test build
+        run: |
+          python3 -m venv fresh_env
+          . fresh_env/bin/activate
+          pip install dist/*.whl
+          fresh_env/bin/python -c "import axsdb; print(axsdb.__version__)"
+
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+#  publish-to-testpypi:  # Uncomment for tests
+#    name: Publish Python distribution to TestPyPI
+#    needs:
+#      - build-wheels
+#    runs-on: ubuntu-latest
+#
+#    environment:
+#      name: testpypi
+#      url: https://test.pypi.org/p/axsdb
+#
+#    permissions:
+#      id-token: write
+#
+#    steps:
+#      - name: Download all the dists
+#        uses: actions/download-artifact@v4
+#        with:
+#          name: python-package-distributions
+#          path: dist/
+#
+#      - name: Publish distribution to TestPyPI
+#        uses: pypa/gh-action-pypi-publish@release/v1
+#        with:
+#          repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish Python distribution to PyPI
+    needs:
+      - build-wheels
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/axsdb
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

axsdb-0.0.2/.gitignore

@@ -0,0 +1,13 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+docs/_build/
+.idea/
+.coverage

axsdb-0.0.2/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.10
+    # Important: If the version changes, do not forget to sync it with the
+    # linting CI workflow
+    hooks:
+      - id: ruff  # linter
+        types_or: [ python, pyi, jupyter ]
+        args: [ --fix, --exit-non-zero-on-fix ]
+      - id: ruff-format
+        types_or: [ python, pyi, jupyter ]
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.8.1
+    hooks:
+      - id: nbstripout
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
+    hooks:
+      - id: taplo-format
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.21  # uv version
+    hooks:
+      - id: uv-export
+        args: [ "--frozen", "--no-hashes", "--output-file=docs/requirements.txt" ]

axsdb-0.0.2/.python-version

@@ -0,0 +1 @@
+3.10

axsdb-0.0.2/.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build options
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"  # Same as dev version (see .python-version file)
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

axsdb-0.0.2/.taplo.toml

@@ -0,0 +1,8 @@
+# Configuration file for taplo, our TOML formatter
+
+include = ["pyproject.toml", ".taplo.toml"]
+
+[formatting]
+align_entries = false
+align_comments = false
+column_width = 88

axsdb-0.0.2/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: axsdb
+Version: 0.0.2
+Summary: An absorption database reader for the Eradiate radiative transfer model.
+Author-email: Vincent Leroy <vincent.leroy@rayference.eu>
+Requires-Python: >=3.9
+Requires-Dist: attrs
+Requires-Dist: cachetools
+Requires-Dist: netcdf4
+Requires-Dist: pint
+Requires-Dist: scipy
+Requires-Dist: typer
+Requires-Dist: xarray
+Description-Content-Type: text/markdown
+
+# AxsDB — The Eradiate Absorption Cross-section Database Interface
+
+[![PyPI version](https://img.shields.io/pypi/v/axsdb?color=blue)](https://pypi.org/project/axsdb)
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/eradiate/axsdb/ci.yml?branch=main)](https://github.com/eradiate/axsdb/actions/workflows/ci.yml)
+[![Documentation Status](https://img.shields.io/readthedocs/axsdb)](https://axsdb.readthedocs.io)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+This library provides an interface to read and
+query [Eradiate](https://eradiate.eu)'s absorption databases.
+
+## License
+
+The Eradiate Absorption Database Reader is distributed under the terms of the
+[GNU Lesser General Public License v3.0](https://choosealicense.com/licenses/lgpl-3.0/).

axsdb-0.0.2/README.md

@@ -0,0 +1,15 @@
+# AxsDB — The Eradiate Absorption Cross-section Database Interface
+
+[![PyPI version](https://img.shields.io/pypi/v/axsdb?color=blue)](https://pypi.org/project/axsdb)
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/eradiate/axsdb/ci.yml?branch=main)](https://github.com/eradiate/axsdb/actions/workflows/ci.yml)
+[![Documentation Status](https://img.shields.io/readthedocs/axsdb)](https://axsdb.readthedocs.io)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+This library provides an interface to read and
+query [Eradiate](https://eradiate.eu)'s absorption databases.
+
+## License
+
+The Eradiate Absorption Database Reader is distributed under the terms of the
+[GNU Lesser General Public License v3.0](https://choosealicense.com/licenses/lgpl-3.0/).

axsdb-0.0.2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

axsdb-0.0.2/docs/api.rst

@@ -0,0 +1,10 @@
+:tocdepth: 2
+
+API reference
+=============
+
+.. automodule:: axsdb
+    :autosummary:
+    :members:
+    :show-inheritance:
+    :inherited-members:

axsdb-0.0.2/docs/conf.py

@@ -0,0 +1,56 @@
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import axsdb
+
+project = "axsdb"
+copyright = "2025, Vincent Leroy"
+author = "Vincent Leroy"
+version = axsdb.__version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    # Core extensions
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    # Third-party
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_iconify",
+    "autodocsumm",
+]
+
+templates_path = ["_templates"]
+source_suffix = [".rst", ".md"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
+    "pandas": ("https://pandas.pydata.org/docs/", None),
+    "cachetools": ("https://cachetools.readthedocs.io/en/stable/", None),
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+
+html_static_path = ["_static"]
+html_title = "axsdb"
+
+# Use Shibuya theme
+# https://shibuya.lepture.com/
+html_theme = "shibuya"
+html_theme_options = {
+    "accent_color": "indigo",
+    "navigation_with_keys": True,
+    "github_url": "https://github.com/eradiate/axsdb",
+}

axsdb-0.0.2/docs/getting_started.rst

@@ -0,0 +1,15 @@
+Getting started
+===============
+
+Installation
+------------
+
+Required dependencies:
+
+* Python 3.9 or later
+
+Install from PyPI in your virtual environment:
+
+.. code:: shell
+
+    python -m pip install axsdb

axsdb-0.0.2/docs/index.rst

@@ -0,0 +1,32 @@
+:hide-toc:
+:layout: landing
+
+AxsDB documentation
+===================
+
+**Date**: |today| | **Version**: |version|
+
+AxsDB is provides an interface to `Eradiate <https://eradiate.eu>`_\ 's
+absorption cross section databases.
+
+.. grid:: 1 1 2 3
+    :gutter: 2
+    :padding: 0
+
+    .. grid-item-card:: :iconify:`material-symbols:book-2 height=1.5em` Docs
+        :link: getting_started
+        :link-type: doc
+
+        Read about AxsDB and its API.
+
+    .. grid-item-card:: :iconify:`simple-icons:github height=1.5em` GitHub
+        :link: https://github.com/eradiate/axsdb/
+
+        Browse the source code.
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    getting_started
+    api

axsdb-0.0.2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd