rtc-tools 2.8.0.dev0__tar.gz → 2.8.0rc1__tar.gz

rtc_tools-2.8.0rc1/.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.0rc1/.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.0rc1/.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/rtc-tools/rtc-tools/issues/1536
+2503c49901bc4a7a3dc86d46b234e8973ed2feb5
+476aeb27d164cebe3781de7f9a40b04b839a5220
+cf540b1ad8fc39909e6e05e7656901e26daefb62
+c623c053a97506b120ab546aa406b4706f2cf200
+cef7507e09c0f187ad209e949575a04b7204cbe9
+30868b64e85c56d971cbccb622466a1fe46bcd82
+8929d6eac903af87ef982566cb07f45369eedda1
+ee870e42deda8974e482e96995c5c136a8cfe07c
+7908178e50ababa32534d205d62d525049b60dc3
+# END https://github.com/rtc-tools/rtc-tools/issues/1536
+
+# START https://github.com/rtc-tools/rtc-tools/pull/1652
+3df9a9ed5dfcbb6855ee8f4a0d22c4dec9f77507
+c4e20c6c8debaa886eba596c468ee5a438bf73dd
+# END https://github.com/rtc-tools/rtc-tools/pull/1652

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

@@ -0,0 +1,55 @@
+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: ""
+  resolution-mode:
+    description: "Dependency resolution mode: 'frozen' (use uv.lock), 'lowest' (lowest-direct), 'highest' (upgrade to newest)."
+    required: false
+    default: "frozen"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install uv
+      uses: astral-sh/setup-uv@3259c6206f993105e3a61b142c2d97bf4b9ef83d # v7.1.0
+      with:
+        version: ${{ inputs.uv-version }}
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+        github-token: ${{ github.token }}  # Avoid API rate limits
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        CMD_PARTS=("uv" "sync")
+
+        if [[ "${{ inputs.resolution-mode }}" == "lowest" ]]; then
+          CMD_PARTS+=("--resolution" "lowest-direct")
+          echo "UV_RESOLUTION=lowest-direct" >> $GITHUB_ENV
+        elif [[ "${{ inputs.resolution-mode }}" == "highest" ]]; then
+          CMD_PARTS+=("--upgrade")
+          echo "UV_RESOLUTION=highest" >> $GITHUB_ENV
+        else # Default to "frozen"
+          CMD_PARTS+=("--frozen")
+        fi
+
+        # Always exclude the default 'dev' group unless specific groups are requested that might include dev ones by intent.
+        # uv sync --no-dev is the default to exclude [tool.uv.dev-dependencies] or [dependency-groups.dev]
+        CMD_PARTS+=("--no-dev")
+
+        if [[ -n "${{ inputs.dependency-groups }}" ]]; then
+          for group in ${{ inputs.dependency-groups }}; do
+            CMD_PARTS+=("--group" "$group")
+          done
+        fi
+
+        echo "Executing: ${CMD_PARTS[*]}"
+        "${CMD_PARTS[@]}"

rtc_tools-2.8.0rc1/.github/workflows/ci.yml

@@ -0,0 +1,153 @@
+name: Tests & Release
+
+on:
+  push:
+  pull_request:
+  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}}"
+
+permissions:
+  contents: read
+
+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.10
+    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:
+    name: Test Linux (Python ${{ matrix.version }}${{ matrix.label }})
+    needs: build
+    runs-on: ubuntu-latest
+    container:
+      image: python:${{ matrix.version }}
+    timeout-minutes: 30
+    env:
+      TOXENV: py
+    strategy:
+      matrix:
+        include:
+          - version: '3.10'
+          - version: '3.11'
+          - version: '3.12'
+          - version: '3.13'
+          - version: '3.14'
+          # Lowest and highest resolution modes to test oldest and newest dependencies.
+          - version: '3.10'
+            resolution_mode: 'lowest'
+            label: ' (Oldest Dependencies)'
+          - version: '3.14'
+            resolution_mode: 'highest'
+            label: ' (Newest Dependencies)'
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ./.github/actions/setup-python
+      with:
+        dependency-groups: "tests"
+        resolution-mode: ${{ matrix.resolution_mode }}
+    - run: uv run tox -vv
+
+  coverage:
+    needs: build
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.10
+    timeout-minutes: 30
+    env:
+      TOXENV: coverage
+    steps:
+    - uses: actions/checkout@v4.1.0
+      with:
+        # Full history required for accurate Sonar SCM blame data
+        fetch-depth: 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
+    - name: SonarQube Cloud Scan
+      if: ${{ success() && (github.event_name == 'push' || github.event_name == 'pull_request') }}
+      continue-on-error: true
+      uses: SonarSource/sonarqube-scan-action@59db25f34e16620e48ab4bb9e4a5dce155cb5432  # v8.0.0
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+  examples-linux:
+    needs: build
+    runs-on: ubuntu-latest
+    container:
+      image: python:${{ matrix.version }}
+    if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/tags')
+    timeout-minutes: 30
+    env:
+      TOXENV: examples
+    strategy:
+      matrix:
+        version:
+        - '3.10'
+        - '3.11'
+        - '3.12'
+        - '3.13'
+        - '3.14'
+    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.0rc1/.gitignore

@@ -0,0 +1,33 @@
+# 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
+venv

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

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

rtc_tools-2.8.0rc1/.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.0rc1/AUTHORS

@@ -0,0 +1,13 @@
+Farid Alavi
+Jorn Baayen
+Joris Bentvelsen
+Olav van Duin
+Sjoerd Geevers
+Joris Gillis
+Klaudia Horváth
+Ailbhe Mitchell
+Teresa Piovesan
+Jesús A. Rodríguez
+Matthijs den Toom
+Jesse VanderWees
+Tjerk Vreeken

rtc_tools-2.8.0rc1/CHARTER.md

@@ -0,0 +1,127 @@
+# Technical Charter (the "Charter")
+
+for
+
+RTC-Tools a Series of LF Projects, LLC
+
+The full charter is available at: [RTC-Tools Technical Charter (PDF)](https://lfx-cdn-prod.s3.us-east-1.amazonaws.com/project-artifacts/rtc-tools/rtc-tools_Charter.pdf)
+
+Adopted 7-22-2025
+
+---
+
+This Charter sets forth the responsibilities and procedures for technical contribution to, and oversight of, the RTC-Tools open source project, which has been established as RTC-Tools a Series of LF Projects, LLC (the “Project”). LF Projects, LLC (“LF Projects”) is a Delaware series limited liability company. All contributors (including committers, maintainers, and other technical positions) and other participants in the Project (collectively, “Collaborators”) must comply with the terms of this Charter.
+
+---
+
+## 1. Mission and Scope of the Project
+
+a. The mission of the Project is to provide a robust, flexible, and scalable framework that empowers organizations to efficiently manage and optimize their assets, contributing to sustainable water and energy solutions worldwide.
+
+b. The scope of the Project includes collaborative development under the Project License (as defined herein) supporting the mission, including documentation, testing, integration and the creation of other artifacts that aid the development, deployment, operation or adoption of the open source project.
+
+---
+
+## 2. Technical Steering Committee
+
+a. The Technical Steering Committee (the “TSC”) will be responsible for all technical oversight of the open source Project.
+
+b. The TSC voting members are initially the Project’s Committers. At the inception of the project, the Committers of the Project will be as set forth within the “CONTRIBUTING” file within the Project’s code repository. The TSC may choose an alternative approach for determining the voting members of the TSC, and any such alternative approach will be documented in the CONTRIBUTING file. Any meetings of the Technical Steering Committee are intended to be open to the public, and can be conducted electronically, via teleconference, or in person.
+
+c. TSC projects generally will involve Contributors and Committers. The TSC may adopt or modify roles so long as the roles are documented in the CONTRIBUTING file. Unless otherwise documented:
+
+    i. Contributors include anyone in the technical community that contributes code, documentation, or other technical artifacts to the Project;
+
+    ii. Committers are Contributors who have earned the ability to modify (“commit”) source code, documentation or other technical artifacts in a project’s repository; and
+
+    iii. A Contributor may become a Committer by a majority approval of the existing Committers. A Committer may be removed by a majority approval of the other existing Committers.
+
+d. Participation in the Project through becoming a Contributor and Committer is open to anyone so long as they abide by the terms of this Charter.
+
+e. The TSC may (1) establish work flow procedures for the submission, approval, and closure/archiving of projects, (2) set requirements for the promotion of Contributors to Committer status, as applicable, and (3) amend, adjust, refine and/or eliminate the roles of Contributors, and Committers, and create new roles, and publicly document any TSC roles, as it sees fit.
+
+f. The TSC may elect a TSC Chair, who will preside over meetings of the TSC and will serve until their resignation or replacement by the TSC. The TSC Chair, or any other TSC member so designated by the TSC, will serve as the primary communication contact between the Project and LF Energy, a directed fund of The Linux Foundation. The Project has been initialized at Deltares. To acknowledge this, the TSC Chair is offered to Deltares first. If Deltares does not provide a candidate, other TSC members can be elected.
+
+g. Responsibilities: The TSC will be responsible for all aspects of oversight relating to the Project, which may include:
+
+    i. coordinating the technical direction of the Project;
+    ii. approving project or system proposals (including, but not limited to, incubation, deprecation, and changes to a sub-project’s scope);
+    iii. organizing sub-projects and removing sub-projects;
+    iv. creating sub-committees or working groups to focus on cross-project technical issues and requirements;
+    v. appointing representatives to work with other open source or open standards communities;
+    vi. establishing community norms, workflows, issuing releases, and security issue reporting policies;
+    vii. approving and implementing policies and processes for contributing (to be published in the CONTRIBUTING file) and coordinating with the series manager of the Project (as provided for in the Series Agreement, the “Series Manager”) to resolve matters or concerns that may arise as set forth in Section 7 of this Charter;
+    viii. discussions, seeking consensus, and where necessary, voting on technical matters relating to the code base that affect multiple projects; and
+    ix. coordinating any marketing, events, or communications regarding the Project.
+
+---
+
+## 3. TSC Voting
+
+a. While the Project aims to operate as a consensus-based community, if any TSC decision requires a vote to move the Project forward, the voting members of the TSC will vote on a one vote per voting member basis.
+
+b. Quorum for TSC meetings requires at least fifty percent of all voting members of the TSC to be present. The TSC may continue to meet if quorum is not met but will be prevented from making any decisions at the meeting.
+
+c. Except as provided in Section 7.c. and 8.a, decisions by vote at a meeting require a majority vote of those in attendance, provided quorum is met. Decisions made by electronic vote without a meeting require a majority vote of all voting members of the TSC.
+
+d. In the event a vote cannot be resolved by the TSC, any voting member of the TSC may refer the matter to the Series Manager for assistance in reaching a resolution.
+
+---
+
+## 4. Compliance with Policies
+
+a. This Charter is subject to the Series Agreement for the Project and the Operating Agreement of LF Projects. Contributors will comply with the policies of LF Projects as may be adopted and amended by LF Projects, including, without limitation the policies listed at https://lfprojects.org/policies/.
+
+b. The TSC may adopt a code of conduct (“CoC”) for the Project, which is subject to approval by the Series Manager. In the event that a Project-specific CoC has not been approved, the LF Projects Code of Conduct listed at https://lfprojects.org/policies will apply for all Collaborators in the Project.
+
+c. When amending or adopting any policy applicable to the Project, LF Projects will publish such policy, as to be amended or adopted, on its web site at least 30 days prior to such policy taking effect; provided, however, that in the case of any amendment of the Trademark Policy or Terms of Use of LF Projects, any such amendment is effective upon publication on LF Project’s web site.
+
+d. All Collaborators must allow open participation from any individual or organization meeting the requirements for contributing under this Charter and any policies adopted for all Collaborators by the TSC, regardless of competitive interests. Put another way, the Project community must not seek to exclude any participant based on any criteria, requirement, or reason other than those that are reasonable and applied on a non-discriminatory basis to all Collaborators in the Project community.
+
+e. The Project will operate in a transparent, open, collaborative, and ethical manner at all times. The output of all Project discussions, proposals, timelines, decisions, and status should be made open and easily visible to all. Any potential violations of this requirement should be reported immediately to the Series Manager.
+
+---
+
+## 5. Community Assets
+
+a. LF Projects will hold title to all trade or service marks used by the Project (“Project Trademarks”), whether based on common law or registered rights. Project Trademarks will be transferred and assigned to LF Projects to hold on behalf of the Project. Any use of any Project Trademarks by Collaborators in the Project will be in accordance with the license from LF Projects and inure to the benefit of LF Projects.
+
+b. The Project will, as permitted and in accordance with such license from LF Projects, develop and own all Project GitHub and social media accounts, and domain name registrations created by the Project community.
+
+c. Under no circumstances will LF Projects be expected or required to undertake any action on behalf of the Project that is inconsistent with the tax-exempt status or purpose, as applicable, of the Joint Development Foundation or LF Projects, LLC.
+
+---
+
+## 6. General Rules and Operations
+
+a. The Project will:
+
+    i. engage in the work of the Project in a professional manner consistent with maintaining a cohesive community, while also maintaining the goodwill and esteem of LF Projects, Joint Development Foundation and other partner organizations in the open source community; and
+    ii. respect the rights of all trademark owners, including any branding and trademark usage guidelines.
+
+
+## 7. Intellectual Property Policy
+
+a. Collaborators acknowledge that the copyright in all new contributions will be retained by the copyright holder as independent works of authorship and that no contributor or copyright holder will be required to assign copyrights to the Project.
+
+b. Except as described in Section 7.c., all contributions to the Project are subject to the following:
+
+    i. All new inbound code contributions to the Project must be made using GNU Lesser General Public License v3.0GNU Library General Public License, Version 3.0, available at https://github.com/Deltares/rtc-tools/blob/master/COPYING (the “Project License”).
+
+    ii. All new inbound code contributions must also be accompanied by a Developer Certificate of Origin (http://developercertificate.org) sign-off in the source code system that is submitted through a TSC-approved contribution process which will bind the authorized contributor and, if not self-employed, their employer to the applicable license;
+
+    iii. All outbound code will be made available under the Project License.
+
+    iv. Documentation will be received and made available by the Project under the Creative Commons Attribution 4.0 International License (available at http://creativecommons.org/licenses/by/4.0/).
+
+    v. The Project may seek to integrate and contribute back to other open source projects (“Upstream Projects”). In such cases, the Project will conform to all license requirements of the Upstream Projects, including dependencies, leveraged by the Project. Upstream Project code contributions not stored within the Project’s main code repository will comply with the contribution process and license terms for the applicable Upstream Project.
+
+c. The TSC may approve the use of an alternative license or licenses for inbound or outbound contributions on an exception basis. To request an exception, please describe the contribution, the alternative open source license(s), and the justification for using an alternative open source license for the Project. License exceptions must be approved by a two-thirds vote of the entire TSC.
+
+d. Contributed files should contain license information, such as SPDX short form identifiers, indicating the open source license or licenses pertaining to the file.
+
+---
+
+## 8. Amendments
+
+a. This charter may be amended by a two-thirds vote of the entire TSC and is subject to approval