rtc-tools 2.7.0.dev1__tar.gz → 2.8.0a0__tar.gz

rtc_tools-2.8.0a0/.codecov.yml

@@ -0,0 +1,12 @@
+codecov:
+  branch: master
+coverage:
+  status:
+    project:
+      default:
+        threshold: 5
+    patch:
+      default:
+        target: 0%
+comment:
+  layout: "header, tree"

rtc_tools-2.8.0a0/.coveragerc

@@ -0,0 +1,15 @@
+[run]
+branch = True
+source = rtctools
+relative_files = True
+
+[report]
+show_missing = true
+exclude_lines =
+    pragma: no cover
+    raise NotImplementedError
+
+[paths]
+source =
+    src/rtctools
+    */site-packages/rtctools

rtc_tools-2.8.0a0/.git-blame-ignore-revs

@@ -0,0 +1,35 @@
+# This file contains revisions to be ignored by git blame.
+# These revisions are expected to be formatting-only changes.
+#
+# Calling `git blame --ignore-revs-file .git-blame-ignore-revs` will
+# tell git blame to ignore changes made by these revisions when assigning
+# assigning blame, as if the change never happened.
+#
+# You can enable this as a default for your local repository by running
+# `git config blame.ignoreRevsFile .git-blame-ignore-revs`
+# This will probably be automatically picked by your IDE
+#
+# Important: if you are switching to the branch without this file,
+# `git blame` will fail with an error
+#
+# Guidelines:
+# - Only large automated refactorings are expected to be included in this file.
+#   Do not add new revision just because it feels unimportant
+# - Add a link to the relevant issue/MR
+
+# START https://github.com/Deltares/rtc-tools/issues/1536
+2503c49901bc4a7a3dc86d46b234e8973ed2feb5
+476aeb27d164cebe3781de7f9a40b04b839a5220
+cf540b1ad8fc39909e6e05e7656901e26daefb62
+c623c053a97506b120ab546aa406b4706f2cf200
+cef7507e09c0f187ad209e949575a04b7204cbe9
+30868b64e85c56d971cbccb622466a1fe46bcd82
+8929d6eac903af87ef982566cb07f45369eedda1
+ee870e42deda8974e482e96995c5c136a8cfe07c
+7908178e50ababa32534d205d62d525049b60dc3
+# END https://github.com/Deltares/rtc-tools/issues/1536
+
+# START https://github.com/Deltares/rtc-tools/pull/1652
+3df9a9ed5dfcbb6855ee8f4a0d22c4dec9f77507
+c4e20c6c8debaa886eba596c468ee5a438bf73dd
+# END https://github.com/Deltares/rtc-tools/pull/1652

rtc_tools-2.8.0a0/.github/actions/setup-python/action.yml

@@ -0,0 +1,33 @@
+name: "Setup Python Environment"
+description: "Sets up Python environment with uv package manager"
+
+inputs:
+  uv-version:
+    description: "Version of uv to install"
+    required: false
+    default: "0.7.9"
+  dependency-groups:
+    description: "Space-separated list of dependency groups to install (e.g. 'deploy tests')"
+    required: false
+    default: ""
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: ${{ inputs.uv-version }}
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        CMD="uv sync --frozen --no-dev"
+        if [[ -n "${{ inputs.dependency-groups }}" ]]; then
+          for group in ${{ inputs.dependency-groups }}; do
+            CMD="$CMD --group $group"
+          done
+        fi
+        $CMD

rtc_tools-2.8.0a0/.github/workflows/rtc-tools.yml

@@ -0,0 +1,147 @@
+name: deltares/rtc-tools
+
+on:
+  push:
+  workflow_dispatch:
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+# env:
+#   PYPI_USER: "${{ secrets.PYPI_USER }}"
+#   PYPI_PASSWORD: "${{ secrets.PYPI_PASSWORD }}"
+#   CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN}}"
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ./.github/actions/setup-python
+      with:
+        dependency-groups: "style"
+    - run: uv run pre-commit run --all-files --show-diff-on-failure
+
+  build:
+    needs: [style]
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.9
+    timeout-minutes: 30
+    steps:
+    - uses: actions/checkout@v4.1.0
+      with:
+        fetch-depth: 0
+    - uses: ./.github/actions/setup-python
+    - run: uv build
+    - uses: actions/upload-artifact@v4
+      if: success()
+      with:
+        name: "${{ github.job }}"
+        retention-days: 7
+        path: dist/
+
+  test-linux:
+    needs: build
+    runs-on: ubuntu-latest
+    container:
+      image: python:${{ matrix.version }}
+    timeout-minutes: 30
+    env:
+      TOXENV: py
+    strategy:
+      matrix:
+        version:  # Also update sonar-project.properties when updating the python versions.
+        - '3.9'
+        - '3.10'
+        - '3.11'
+        - '3.12'
+        - '3.13'
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ./.github/actions/setup-python
+      with:
+        dependency-groups: "tests"
+    - run: uv run tox -vv
+
+  coverage:
+    needs: build
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.9
+    timeout-minutes: 30
+    env:
+      TOXENV: coverage
+    steps:
+    - uses: actions/checkout@v4.1.0
+    - uses: ./.github/actions/setup-python
+      with:
+        dependency-groups: "tests"
+    - run: uv run tox -vv
+    - name: Upload coverage report
+      uses: actions/upload-artifact@v4
+      if: success()
+      with:
+        name: coverage-report
+        retention-days: 7
+        path: coverage.xml
+
+  sonar:
+    needs: [coverage]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis.
+      - name: Download coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+      - name: SonarQube Scan
+        uses: SonarSource/sonarqube-scan-action@v5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+  examples-linux:
+    needs: build
+    runs-on: ubuntu-latest
+    container:
+      image: python:${{ matrix.version }}
+    if: startsWith(github.ref, 'refs/tags')
+    timeout-minutes: 30
+    env:
+      TOXENV: examples
+    strategy:
+      matrix:
+        version:
+        - '3.9'
+        - '3.10'
+        - '3.11'
+        - '3.12'
+        - '3.13'
+    steps:
+    - uses: actions/checkout@v4.1.0
+    - uses: ./.github/actions/setup-python
+      with:
+        dependency-groups: "tests"
+    - run: uv run tox -vv
+
+  deploy:
+    needs: [test-linux, coverage, examples-linux]
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/2.')  }}
+    permissions:
+      id-token: write  # Required for OIDC PyPI publishing
+      contents: read
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python and uv
+        uses: ./.github/actions/setup-python
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rtc_tools-2.8.0a0/.gitignore

@@ -0,0 +1,32 @@
+# Byte-compiled / optimized / DLL files
+__pycache__
+*.py[cod]
+
+# C extensions
+*.c
+*.so
+
+# Distribution & Packaging
+.eggs
+build
+dist
+src/*.egg-info
+
+# Testing & Coverage
+.pytest_cache
+.tox
+.coverage
+
+# Example output
+examples/**/output/**/*.csv
+
+# Model caches
+*.pymoca_cache
+
+# Editors
+.idea
+.ipynb_checkpoints
+.vscode
+
+# Virtual environment
+.venv

rtc_tools-2.8.0a0/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+exclude: |
+  (?x)^(
+    src/rtctools/_version\.py|
+    src/rtctools/data/interpolation/__init__\.py|
+    versioneer.py
+  )$
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

rtc_tools-2.8.0a0/.readthedocs.yaml

@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
+
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py

rtc_tools-2.8.0a0/AUTHORS

@@ -0,0 +1,10 @@
+Jorn Baayen
+Joris Bentvelsen
+Olav van Duin
+Sjoerd Geevers
+Klaudia Horváth
+Ailbhe Mitchell
+Teresa Piovesan
+Matthijs den Toom
+Jesse VanderWees
+Tjerk Vreeken

rtc_tools-2.8.0a0/CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# Contributing to RTC-Tools 2
+
+There are many ways you can contribute to RTC-Tools, such as:
+
+- **Reporting issues**: If you encounter any bugs, errors, or unexpected behavior while using RTC-Tools, 
+please report them on our [issue tracker](https://github.com/deltares/rtc-tools/issues).
+Please follow the issue template and provide as much information as possible to help us reproduce and fix the issue.
+- **Suggesting features**: If you have any ideas or suggestions for new features or improvements, 
+please share them on our [issue tracker](https://github.com/deltares/rtc-tools/issues).
+Please use the appropriate category and tag for your topic and explain your motivation and use case clearly.
+- **Submitting merge requests**: If you want to contribute code or documentation to RTC-Tools, 
+please fork the repository and create a merge request.
+Please write docstrings for your functions and classes and make sure your changes pass the tests and checks before submitting.
+Please also add a brief description of your changes and reference any related issues or discussions.
+- **Improving documentation**: If you find any errors, typos, or inconsistencies in the documentation,
+ or if you want to add more examples, tutorials, or explanations, 
+ please feel free to edit the documentation files in the docs folder and submit a merge request.
+Please follow the [Sphinx syntax and style guide](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) for writing documentation.
+- **Reviewing merge requests**: If you are familiar with RTC-Tools and want to help us maintain the quality and consistency of the code and documentation,
+ please review the open merge requests and provide constructive feedback and suggestions.
+- **Testing new releases**: If you want to help us test the new features and bug fixes before they are officially released, 
+please install the latest development version of RTC-Tools from the [GitHub repository](https://github.com/deltares/rtc-tools)
+ and report any issues or feedback on the [issue tracker](https://github.com/deltares/rtc-tools/issues).
+
+## Guidelines for creating issues
+1. **Title**: Provide a concise and informative title. The title should summarize the problem.
+2. **Description**: Describe the issue in detail. Include steps to reproduce the issue, expected behavior, and actual behavior.
+3. **Labels**: Use labels to categorize the issue. This helps in prioritizing and resolving issues.
+4. **Screenshots**: If applicable, add screenshots to help explain the problem.
+5. **Environment**: Mention the version of RTC-Tools, Python and external packages you're using (CasADi, Pymoca, numpy), along with relevant details about your operating system.
+
+
+## Guidelines for creating merge requests
+1. **Identify or create issue**: Before making any changes,
+please open an issue following the guidelines above,
+or comment on an existing one in the
+[issue tracker](https://github.com/deltares/rtc-tools/issues)
+to discuss your ideas with the maintainers.
+This will help us avoid duplication of work
+and ensure that your contribution aligns with the goals of the project.
+2. **Branch**: Create a new branch for each merge request. The branch name should be descriptive and reflect the changes being made.
+3. **Commit**: Please make your commits following the guidelines in the [Commits and Commit Messages](#commits-and-commit-messages) section below.
+4. **Write tests**: If possible, write tests that cover your changes, and add them to the `tests` folder.
+This will help ensure that your changes result in the desired behavior and that functionalities will not accidently break in the future.
+5. **Documentation**: Please also update the documentation if necessary and add examples to the `examples` folder.
+6. **Create merge request**: Mention the corresponding issue from the [issue tracker](https://github.com/deltares/rtc-tools/issues).
+Describe what changes you've made, why you've made them, and how they address the issue at hand.
+7. **Code review**: Request code review from your peers. Address any comments or suggestions they might have.
+
+
+## Commits and Commit Messages
+
+Each commit ideally satisfies the following:
+
+- Each commit has a clear and single purpose.
+- After each commit, all unit tests should still pass.
+
+Commit messages should have the following structure:
+
+```text
+<scope>: <short description>
+
+<complete description>
+```
+
+- scope: explains which part of the code is affected, e.g.:
+    - optimization (only affects the optimization part)
+    - homotopy_mixin (only affects the homotopy_mixin module)
+    - tests (only affects the tests)
+    - doc (only affects the documentation)
+- short description: describes what is changed in the commit with a single sentence.
+- complete description: explain in detail what is done in the commit and why.
+    This can take up multiple paragraphs.
+
+
+## Setting up a development environment
+
+To set up your development environment, you will need:
+
+- Python 3.9 or higher (up to 3.13)
+- Git
+
+You can clone the repository and install it from source:
+
+```bash
+git clone https://github.com/Deltares/RTC-Tools.git
+cd RTC-Tools
+uv sync
+```
+
+To ensure that your code meets our standards, we recommend using pre-commit.
+Run the following command to set up the pre-commit hook:
+```bash
+pre-commit install
+```
+. This will
+automatically check your code for formatting and linting issues before each
+commit.
+
+
+To run the tests:
+
+```bash
+pytest tests
+```
+
+To build the documentation:
+
+```bash
+cd doc
+make html
+```
+
+## Version numbering and release cycle
+
+For version numbers we use the guidelines described in <https://semver.org>:
+
+> Given a version number MAJOR.MINOR.PATCH, increment the:
+> 
+> 1. MAJOR version when you make incompatible API changes
+> 2. MINOR version when you add functionality in a backward compatible manner
+> 3. PATCH version when you make backward compatible bug fixes
+> 
+> Additional labels for pre-release and build metadata are available
+> as extensions to the MAJOR.MINOR.PATCH format.
+
+The development of a new MINOR version in RTC-Tools consists of four stages:
+
+1. Alpha (a): Version that is not yet feature complete and may contain bugs.
+    Each alpha release can either fix bugs or add new features.
+2. Beta (b): Version that is feature complete but is likely to contain bugs.
+    After a beta version has been created, no new features can be added anymore.
+    A beta version is tested more thoroughly.
+3. Release candidate (rc): Version that has been tested through the beta versions releases
+    and can now be tested as if it were the stable release.
+    If bugs still pop up, new RC versions can be created to fix them.
+    Additions are allowed but should be code-unrelated,
+    such as changes to the documentation required for the release.
+4. Stable release: Final version that has passed all tests.
+
+There can be multiple alpha-, beta-, and rc-versions,
+but we should not go back to a previous stage.
+
+An example of a release sequence is:
+
+- 2.6.0a1 Add a feature.
+- 2.6.0a2 Add another feature and fix a bug.
+- 2.6.0b1 First beta release.
+- 2.6.0b2 Fixed a bug.
+- 2.6.0b3 Fixed another bug.
+- 2.6.0rc1 First release candidate after having tested thoroughly.
+- 2.6.0rc2 Fixed a bug that did not show up in the standard tests.
+- 2.6.0 **Stable release**.
+    No changes were made after last release candidate.
+- 2.6.1 Fixed a bug.
+- 2.6.2 Fixed another bug.
+
+If we start with a new release cycle for X.Y+1,
+and still want to fix a bug for the previous version X.Y,
+we create a separate branch `maintenance/X.Y` where we add patches for X.Y.
+
+## Release Notes
+
+Before creating a release, make sure that the release notes are updated in
+[RELEASE_NOTES.md](RELEASE_NOTES.md).
+
+
+## Contact
+
+If you have any questions or comments about RTC-Tools, please contact us at rtctools@deltares.nl.
+
+We hope you enjoy using and contributing to RTC-Tools!