pydirectional 0.1.3__tar.gz

pydirectional-0.1.3/.github/workflows/publish.yml

@@ -0,0 +1,105 @@
+name: Publish to PyPI
+
+# Triggered by pushing a v* tag, or manually via the "Run workflow" button.
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      confirm:
+        description: "Type 'publish' to confirm release"
+        required: true
+
+jobs:
+  # -----------------------------------------------------------------------
+  # Guard: manual runs require the confirmation input.
+  # -----------------------------------------------------------------------
+  check:
+    name: Check confirmation
+    runs-on: ubuntu-latest
+    if: >
+      github.event_name == 'push' ||
+      github.event.inputs.confirm == 'publish'
+    steps:
+      - run: echo "Confirmed — proceeding with release."
+
+  # -----------------------------------------------------------------------
+  # Test gate: don't publish if tests fail.
+  # -----------------------------------------------------------------------
+  test:
+    name: Tests (Python 3.13)
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+      - name: Configure NPL package registry
+        run: |
+          echo -e "machine gitlab.npl.co.uk\nlogin gitlab-ci-token\npassword ${{ secrets.NPL_GITLAB_REMOVED_TOKEN }}" >> ~/.netrc
+      - run: pip install -e ".[dev]"
+      - run: pytest --cov=pydirectional
+
+  # -----------------------------------------------------------------------
+  # Build source distribution and wheel.
+  # -----------------------------------------------------------------------
+  build:
+    name: Build distribution
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history so setuptools_scm picks up the tag
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build
+        run: |
+          pip install build
+          python -m build
+
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # -----------------------------------------------------------------------
+  # Publish to PyPI via trusted publisher (OIDC — no API token needed).
+  #
+  # One-time setup required in the PyPI project settings:
+  #   Publisher:  GitHub Actions
+  #   Owner:      <your-github-org>
+  #   Repository: pydirectional
+  #   Workflow:   publish.yml
+  #
+  # For a private/internal registry, replace the `repository-url` below and
+  # use a repository secret instead of trusted publishing.
+  # -----------------------------------------------------------------------
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pydirectional
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+
+    steps:
+      - name: Download distribution packages
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uncomment for a private registry:
+        # with:
+        #   repository-url: https://your-registry/simple/

pydirectional-0.1.3/.github/workflows/tests.yml

@@ -0,0 +1,80 @@
+name: Tests
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  test:
+    name: "Python ${{ matrix.python-version }}"
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+        include:
+          # Full matrix on manually-triggered runs and tags only
+          - python-version: "3.11"
+            if-tag-or-manual: true
+          - python-version: "3.12"
+            if-tag-or-manual: true
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Configure NPL package registry
+        run: |
+          echo -e "machine gitlab.npl.co.uk\nlogin gitlab-ci-token\npassword ${{ secrets.NPL_GITLAB_REMOVED_TOKEN }}" >> ~/.netrc
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: |
+          mkdir -p test_report
+          pytest \
+            --html=test_report/report.html \
+            --cov-report html:test_report/cov_report \
+            --cov-report xml:test_report/coverage.xml \
+            --junitxml=test_report/junit.xml \
+            --cov=pydirectional
+
+      - name: Upload test report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-report-py${{ matrix.python-version }}
+          path: test_report/
+          retention-days: 7
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v4
+        with:
+          files: test_report/coverage.xml
+          fail_ci_if_error: false
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - name: ruff format
+        run: ruff format --check pydirectional
+      - name: ruff lint
+        run: ruff check pydirectional
+      - name: mypy
+        run: mypy pydirectional

pydirectional-0.1.3/.gitignore

@@ -0,0 +1,124 @@
+# Mypy cache
+.mypy_cache
+
+# Scratch examples (local experiments, not committed)
+examples/scratch/
+
+# Compiles docs for gitlab pages
+public
+latex
+
+# Visual studio / pycharm folders
+.idea
+.vscode
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/content/developer/generated
+docs/content/user/generated
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# ruff
+.ruff_cache/
+
+# IDE settings
+.vscode/.git.old

pydirectional-0.1.3/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

pydirectional-0.1.3/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pydirectional-0.1.3/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

pydirectional-0.1.3/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

pydirectional-0.1.3/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: pydirectional
+Version: 0.1.3
+Summary: Bidirectional Reflectance Distribution Function (BRDF) modeling tools
+Author-email: MetEOR Toolkit Team <team@comet-toolkit.org>
+Project-URL: Homepage, https://comet-toolkit.org
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: scipy
+Requires-Dist: matheo
+Requires-Dist: curepy
+Requires-Dist: xarray
+Requires-Dist: netcdf4
+Requires-Dist: processor_tools
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-html; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinx_book_theme; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: sphinx_automodapi; extra == "docs"
+Requires-Dist: myst_parser; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
+Dynamic: license-file
+
+# pydirectional
+
+BRDF (Bidirectional Reflectance Distribution Function) modeling tools.
+
+`pydirectional` provides forward models, fitting routines, and utilities for
+working with BRDF measurements and standard semi-empirical models (RTLS, RPV,
+Hapke, and others).
+
+> **Warning:** This software is in beta. Results should be used with
+> caution. Please share any feedback via the issue tracker.
+
+## Usage
+
+### Virtual environment
+
+It is always recommended to use a virtual environment for each Python project.
+Use your preferred environment manager, or create one with:
+
+```bash
+python -m venv venv
+```
+
+Activate it on Windows with `venv\Scripts\activate`, or on macOS/Linux with
+`source venv/bin/activate`.
+
+### Installation
+
+Install the package and its core dependencies:
+
+```bash
+pip install -e .
+```
+
+Optional extras are available depending on your use case:
+
+```bash
+pip install -e ".[dev]"   # Development tools (ruff, mypy, pytest, …)
+pip install -e ".[docs]"  # Documentation build (sphinx, …)
+```
+
+### Development
+
+Install the pre-commit hooks after cloning:
+
+```bash
+pre-commit install
+```
+
+When you commit, `ruff` will lint and format your code. If it makes
+corrections the commit will be aborted so you can review the changes — just
+commit again once you are happy.
+
+Run the test suite with:
+
+```bash
+pytest
+```
+
+## Compatibility
+
+`pydirectional` requires Python 3.11 or later and is tested on Python 3.11,
+3.12, and 3.13.
+
+## Licence
+
+`pydirectional` is released under the GNU Lesser General Public License v3
+(LGPLv3). See the [LICENSE](LICENSE) file for the full licence text.
+
+## Authors
+
+`pydirectional` is developed and maintained by the
+[MetEOR Toolkit Team](mailto:team@comet-toolkit.org).

pydirectional-0.1.3/README.md

@@ -0,0 +1,72 @@
+# pydirectional
+
+BRDF (Bidirectional Reflectance Distribution Function) modeling tools.
+
+`pydirectional` provides forward models, fitting routines, and utilities for
+working with BRDF measurements and standard semi-empirical models (RTLS, RPV,
+Hapke, and others).
+
+> **Warning:** This software is in beta. Results should be used with
+> caution. Please share any feedback via the issue tracker.
+
+## Usage
+
+### Virtual environment
+
+It is always recommended to use a virtual environment for each Python project.
+Use your preferred environment manager, or create one with:
+
+```bash
+python -m venv venv
+```
+
+Activate it on Windows with `venv\Scripts\activate`, or on macOS/Linux with
+`source venv/bin/activate`.
+
+### Installation
+
+Install the package and its core dependencies:
+
+```bash
+pip install -e .
+```
+
+Optional extras are available depending on your use case:
+
+```bash
+pip install -e ".[dev]"   # Development tools (ruff, mypy, pytest, …)
+pip install -e ".[docs]"  # Documentation build (sphinx, …)
+```
+
+### Development
+
+Install the pre-commit hooks after cloning:
+
+```bash
+pre-commit install
+```
+
+When you commit, `ruff` will lint and format your code. If it makes
+corrections the commit will be aborted so you can review the changes — just
+commit again once you are happy.
+
+Run the test suite with:
+
+```bash
+pytest
+```
+
+## Compatibility
+
+`pydirectional` requires Python 3.11 or later and is tested on Python 3.11,
+3.12, and 3.13.
+
+## Licence
+
+`pydirectional` is released under the GNU Lesser General Public License v3
+(LGPLv3). See the [LICENSE](LICENSE) file for the full licence text.
+
+## Authors
+
+`pydirectional` is developed and maintained by the
+[MetEOR Toolkit Team](mailto:team@comet-toolkit.org).