rafmudaf-floris 3.3.post1.dev316__tar.gz

rafmudaf_floris-3.3.post1.dev316/.codecov.yml

@@ -0,0 +1,20 @@
+# Codecov configuration file
+
+comment: false
+
+coverage:
+    range: 0..100  # sets the range for the color bar in the dashboard
+    round: down
+    precision: 2
+    status:
+        project:
+            default:
+                # allow coverage to drop by this amount and still post success
+                threshold: 10
+        patch:
+            default:
+                threshold: 10
+
+ignore:
+    - "setup.py"
+    - "tests/"

rafmudaf_floris-3.3.post1.dev316/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,78 @@
+---
+name: Bug report
+about: Report a bug to help us improve
+title: 'Bug report'
+labels: "Type: Bug"
+---
+
+<!--
+IMPORTANT NOTES
+
+Thank you for taking the time to report a bug. If you aren't certain whether an issue
+is a bug, please first open a Discussion. Before submitting, please reread your
+description to ensure that other readers can reasonably understand the issue
+you're facing and the impact on your workflow or results.
+
+This form is written in GitHub's Markdown format. For a reference on this type
+of syntax, see GitHub's documentation:
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+This template contains guidance for your submission within the < ! - -, - - > blocks.
+These are comments in HTML syntax and will not appear in the submission.
+Be sure to use the "Preview" feature on GitHub to ensure your submission is formatted as intended.
+
+When including code snippets, please paste the text itself and wrap the code block with
+ticks (see the other character on the tilde ~ key in a US keyboard) to format it as code.
+For example, Python code should be wrapped in ticks like this:
+```python
+def a_func():
+    return 1
+
+a = 1
+b = a_func()
+print(a + b)
+```
+This is preferred over screen shots since it is searchable and others can copy/paste
+the text to run it.
+-->
+
+# Add meaningful title here
+<!--
+A clear and concise description of the bug including what happened
+and what you expected to happen.
+-->
+
+## How to reproduce
+<!--
+Describe how another person with no context can recreate this issue.
+It is typically very helpful to reduce the problem as much as possible
+and share a minimum working example. See the note above on including
+code as text rather than screenshots.
+-->
+
+## Relevant output
+<!--
+Include any output, plots, or other means of communication here to add context to the problem.
+ -->
+
+## Floris version
+<!--
+Share your floris version and how you installed it. You can print the floris version from
+a Python REPL or script with these commands:
+```python
+import floris
+print(floris.__version__)
+```
+ -->
+
+## System Information
+<!-- Add your information here. -->
+ - OS: <e.g. Ubuntu 20.04 or macOS 10.12>
+ - Python version: <Result of `python --version`>
+ - Library versions
+   - Results of `pip freeze`, for example
+   - matplotlib
+   - numpy
+   - numexpr
+   - scipy
+   - pandas

rafmudaf_floris-3.3.post1.dev316/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Usage question
+    url: https://github.com/NatLabRockies/floris/discussions
+    about: Have any questions about using FLORIS? Post in Discussions to engage with the NLR team and FLORIS community.

rafmudaf_floris-3.3.post1.dev316/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,57 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'Feature request'
+labels: 'Type: Enhancement'
+---
+
+<!--
+IMPORTANT NOTES
+
+Thank you for taking the time to suggest a feature. Before submitting,
+please reread your description to ensure that other readers can reasonably
+understand the motivation and proposed solution.
+
+This form is written in GitHub's Markdown format. For a reference on this type
+of syntax, see GitHub's documentation:
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+This template contains guidance for your submission within the < ! - -, - - > blocks.
+These are comments in HTML syntax and will not appear in the submission.
+Be sure to use the "Preview" feature on GitHub to ensure your submission is formatted as intended.
+
+When including code snippets, please paste the text itself and wrap the code block with
+ticks (see the other character on the tilde ~ key in a US keyboard) to format it as code.
+For example, Python code should be wrapped in ticks like this:
+```python
+def a_func():
+    return 1
+
+a = 1
+b = a_func()
+print(a + b)
+```
+This is preferred over screen shots since it is searchable and others can copy/paste
+the text to run it.
+-->
+
+# Add meaningful title here
+<!--
+High level description of the feature request including motivation and background.
+-->
+
+## Proposed solution
+<!--
+Here's an opportunity to prototype a feature. Please include pseudocode, images, or
+any other visual aids to communicate the idea.
+-->
+
+## Alternatives considered
+<!--
+Describe workarounds or alternatives even if hacky or incomplete.
+-->
+
+## Additional context
+<!--
+Optional. Provide anything else that helps to communicate the idea here.
+-->

rafmudaf_floris-3.3.post1.dev316/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,74 @@
+
+<!--
+IMPORTANT NOTES
+
+Is this pull request ready to be merged?
+- Do the existing tests pass and new tests added for new code?
+- Is all development in a state where you are proud to share it with others and
+  willing to ask other people to take the time to review it?
+- Is it documented in such a way that a review can reasonably understand what you've
+  done and why you've done it? Can other users understand how to use your changes?
+If not but opening the pull request will facilitate development, make it a "draft" pull request
+
+This form is written in GitHub's Markdown format. For a reference on this type
+of syntax, see GitHub's documentation:
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+This template contains guidance for your submission within the < ! - -, - - > blocks.
+These are comments in HTML syntax and will not appear in the submission.
+Be sure to use the "Preview" feature on GitHub to ensure your submission is formatted as intended.
+
+When including code snippets, please paste the text itself and wrap the code block with
+ticks (see the other character on the tilde ~ key in a US keyboard) to format it as code.
+For example, Python code should be wrapped in ticks like this:
+```python
+def a_func():
+    return 1
+
+a = 1
+b = a_func()
+print(a + b)
+```
+This is preferred over screen shots since it is searchable and others can copy/paste
+the text to run it.
+-->
+
+
+# Add meaningful title here
+<!--
+Be sure to title your pull request so that readers can scan through the list of PR's and understand
+what this one involves. It should be a few well selected words to get the point across. If you have
+a hard time choosing a brief title, consider splitting the pull request into multiple pull requests.
+Keep in mind that the title will be automatically included in the release notes.
+-->
+Describe your feature here.
+
+## Related issue
+<!--
+If one exists, link to a related GitHub Issue.
+-->
+
+## Impacted areas of the software
+<!--
+List any modules or other areas which should be impacted by this pull request. This helps to determine the verification tests.
+-->
+
+## Additional supporting information
+<!--
+Add any other context about the problem here.
+-->
+
+## Test results, if applicable
+<!--
+Add the results from unit tests and regression tests here along with justification for any failing test cases.
+-->
+
+<!--
+__ For NLR use __
+Release checklist:
+- Update the version in
+    - [ ] README.md (appears twice in README.md)
+    - [ ] pyproject.toml
+- [ ] Verify docs builds correctly
+- [ ] Create a tag in the NREL/FLORIS repository
+-->

rafmudaf_floris-3.3.post1.dev316/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: "pip"
+  directory: "/" # Location of package manifests
+  target-branch: "develop"
+  schedule:
+    interval: "monthly"
+  labels:
+    - "package"
+  ignore:
+    - dependency-name: "*"
+      update-types: ["version-update:semver-minor", "version-update:semver-patch"]

rafmudaf_floris-3.3.post1.dev316/.github/workflows/check-working-examples.yaml

@@ -0,0 +1,67 @@
+name: Check Examples APIs
+
+on: [push, pull_request]
+
+jobs:
+
+  examples-check:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.14"]
+        os: [ubuntu-latest]
+      fail-fast: False
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install project
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+        pip install nbconvert  # For converting Jupyter notebook to python script in the next step
+
+    - name: Run examples (ubuntu, macos)
+      # Run all examples and test that they finish successfully. Do not evaluate the results.
+      # Copy the examples to a new directory outside of the repo to ensure that there is no
+      # reliance on the repo directory structure.
+      run: |
+        mkdir -p temp1/temp2/temp3
+        cp -rL examples temp1/temp2/temp3/.
+        cd temp1/temp2/temp3/examples/
+
+        error_found=0  # 0 is false
+        error_results="Error in example:"
+
+        # Now run the examples in root and  subdirectories
+        echo "Running examples"
+        for d in . $(find . -type d -name "*examples*"); do
+          cd $d
+          echo "========================= Example directory- $d"
+          for i in *.py; do
+            echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Running example- $i"
+
+            # If "convert_examples" is in i, skip this script
+            if [[ $i == *"convert_examples"* ]]; then
+              continue
+            fi
+
+            if ! python $i; then
+              error_results="${error_results}"$'\n'" - ${i}"
+              error_found=1
+            fi
+          done
+          if [ "$d" != "." ]; then
+            cd ..
+          fi
+
+        done
+
+        if [[ $error_found ]]; then
+          echo "${error_results}"
+        fi
+
+        exit $error_found

rafmudaf_floris-3.3.post1.dev316/.github/workflows/continuous-integration-workflow.yaml

@@ -0,0 +1,62 @@
+name: Automated tests & code coverage
+
+on: [push, pull_request]
+
+jobs:
+
+  code-qa-validation:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+      fail-fast: False
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install project
+      run: |
+        python -m pip install --upgrade pip
+        pip install ".[develop]"
+    - uses: pre-commit/action@v3.0.0
+    - name: Run tests (ubuntu, macos)
+      if: matrix.os != 'windows-latest' && (success() || failure())  # Run this step even if the linting step fails
+      run: |
+        mkdir -p temp1/temp2/temp3
+        cp -rL tests temp1/temp2/temp3/.
+        cd temp1/temp2/temp3/
+
+        # -rA displays the captured output for all tests after they're run
+        # See the docs: https://doc.pytest.org/en/latest/reference/reference.html#command-line-flags
+        pytest -rA tests/ --ignore tests/timing.py --ignore tests/profiling.py --ignore tests/reg_tests/gauss_regression_test.py
+    - name: Run tests (windows)
+      if: matrix.os == 'windows-latest' && (success() || failure())  # Run this step even if the linting step fails
+      run: |
+        mkdir -p temp1/temp2/temp3
+        cp -r tests temp1/temp2/temp3/.
+        cd temp1/temp2/temp3/
+
+        # -rA displays the captured output for all tests after they're run
+        # See the docs: https://doc.pytest.org/en/latest/reference/reference.html#command-line-flags
+        pytest -rA tests/ --ignore tests/timing.py --ignore tests/profiling.py --ignore tests/reg_tests/gauss_regression_test.py
+    - name: Generate coverage report
+      # Run these tests on unit tests only so that we avoid inflating our code
+      # coverage through the regression tests
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        pip install pytest
+        pip install pytest-cov
+        pytest --cov=./ --cov-report=xml tests/ --ignore tests/reg_tests --ignore tests/timing.py --ignore tests/profiling.py
+    - name: Upload coverage to Codecov
+      if: ${{ matrix.os == 'ubuntu-latest' && env.CODECOV_TOKEN }}  # Don't attempt to upload if the codecov token is not configured
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{ env.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        fail_ci_if_error: true

rafmudaf_floris-3.3.post1.dev316/.github/workflows/cpp-backend-tests.yml

@@ -0,0 +1,58 @@
+name: C++ backend tests (floraf)
+
+on:
+  push:
+    # branches: [floraf]
+    branches: ["cpp-v4.6.4"]
+  # pull_request:
+  #   branches: [floraf]
+
+jobs:
+  cpp-backend-tests:
+    name: ${{ matrix.os }} / Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-14]
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install floris with test dependencies
+        # Install floris before torch so that scikit-build-core's cmake step
+        # does not attempt to build the (now-removed) floris/cpp extension.
+        run: pip install ".[develop]"
+
+      - name: Install libtorch (CPU)
+        # Install the CPU-only torch wheel explicitly so that the floraf wheel
+        # does not pull in the heavier CUDA variant from PyPI.
+        run: pip install torch --index-url https://download.pytorch.org/whl/cpu
+
+      - name: Download floraf wheel from private releases
+        env:
+          GH_TOKEN: ${{ secrets.FLORAF_WHEEL_TOKEN }}
+        run: |
+          mkdir -p floraf-wheels
+          # Download all cp312 wheels; pip will select the platform-compatible one.
+          gh release download \
+            --repo rafmudaf/floraf \
+            --pattern "*cp312*.whl" \
+            --dir floraf-wheels/
+          ls floraf-wheels/
+
+      - name: Install floraf wheel
+        # --find-links lets pip select the wheel that matches the current platform.
+        run: pip install --find-links floraf-wheels/ floraf
+
+      - name: Run C++ backend integration tests
+        env:
+          FLORAF_LICENSE_KEY: ${{ secrets.FLORAF_LICENSE_KEY }}
+        run: |
+          pytest tests/reg_tests/gauss_regression_test.py -v

rafmudaf_floris-3.3.post1.dev316/.github/workflows/deploy-pages.yaml

@@ -0,0 +1,100 @@
+name: deploy-pages
+
+on:
+  push:
+    branches:
+    - develop
+
+
+  workflow_dispatch:  # Allows manual triggering of the workflow
+
+# This job installs dependencies, builds the book, and pushes it to `gh-pages`
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    # Install dependencies
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3"
+
+    - name: Install dependencies
+      run: |
+        pip install -e ".[docs, develop]"
+
+    # Make a copy of the examples folder within the docs folder
+    - name: Copy examples to docs
+      working-directory: ${{runner.workspace}}/floris/
+      run: |
+        rsync -av examples/ docs/examples
+        ls docs/examples
+
+    # Run the script examples/_convert_examples_to_notebooks.py
+    - name: Convert examples to notebooks
+      working-directory: ${{runner.workspace}}/floris/docs/examples/
+      run: |
+        pwd
+        ls
+        python _convert_examples_to_notebooks.py
+
+    # Build the book
+    - name: Build the book
+      working-directory: ${{runner.workspace}}/floris/docs/
+      run: |
+        jupyter-book build .
+
+    # Push the book's HTML to github-pages
+    - name: GitHub Pages action
+      uses: peaceiris/actions-gh-pages@v4.0.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html
+
+    # Stash changes before benchmark action
+    - name: Stash changes
+      working-directory: ${{runner.workspace}}/floris/
+      run: |
+        git stash
+
+    - name: Run benchmark
+      working-directory: ${{runner.workspace}}/floris/
+      run: |
+        ls -lah
+        cd benchmarks
+        pytest bench.py --benchmark-json output.json
+
+    # Store benchmark result and create the benchmark pages
+    # Update the index.html and data.js files in the
+    # dev/bench folder of the benches branch
+    # dev/bench is the default folder for pytest-benchmark
+    - name: Store benchmark result
+      uses: benchmark-action/github-action-benchmark@v1
+      with:
+        name: Python Benchmark with pytest-benchmark
+        tool: 'pytest'
+        output-file-path: benchmarks/output.json
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        auto-push: true
+        gh-pages-branch: benches
+
+    # Add bench mark files to the gh-pages branch
+    - name: Add benchmark files to gh-pages
+      working-directory: ${{runner.workspace}}/floris/
+      run: |
+        ls -lah
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git config --global user.name "github-actions[bot]"
+        git fetch origin benches
+        git checkout benches
+        rsync -av dev/bench /tmp/bench
+        git fetch origin gh-pages
+        git checkout gh-pages
+        mkdir -p dev
+        rsync -av /tmp/bench/ dev/
+        ls -lah dev/bench
+        git add dev
+        git commit -m "Add bench folder to gh-pages"
+        git push origin gh-pages

rafmudaf_floris-3.3.post1.dev316/.github/workflows/python-publish.yml

@@ -0,0 +1,37 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# Published via GitHub Actions as a PyPI Trusted Publisher.
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+# and: https://docs.pypi.org/trusted-publishers/
+
+name: Upload Python Package
+
+on:
+  push:
+    branches: [cpp-v4.6.4]
+
+jobs:
+  deploy:
+    environment: release-pypi
+    if: github.repository_owner == 'rafmudaf'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+      - name: Install dependencies and build package
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+          python -m build
+          twine check --strict dist/*
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: True

rafmudaf_floris-3.3.post1.dev316/.github/workflows/quality-metrics-workflow.yaml

@@ -0,0 +1,28 @@
+name: Code Quality Check
+
+on: [push, pull_request]
+
+jobs:
+
+  code-qa-validation:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+        os: [ubuntu-latest]
+      fail-fast: False
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install project
+      run: |
+        python -m pip install --upgrade pip
+        pip install ".[develop]"
+    - name: Run the code quality script
+      run: |
+        cd profiling
+        python quality_metrics.py

rafmudaf_floris-3.3.post1.dev316/.gitignore

@@ -0,0 +1,48 @@
+
+# python compiled files
+__pycache__/
+.cache
+*.ipynb
+*.ipynb_checkpoints
+*.pyc
+*.egg-info
+dist
+build
+.pytest_cache
+.ruff_cache
+
+# pip meta data
+pip-wheel-metadata
+
+# macOS files
+.DS_Store
+
+# IDE settings and files
+.idea
+.vscode
+
+# Documentation notebooks
+!docs/*.ipynb
+
+# The examples folder within docs
+docs/examples
+
+# Documentation output
+_site/
+.jekyll-cache/
+_build
+_autosummary/
+
+# Output from examples
+examples/cp_ct_cq_lut.p
+examples/hist.hist
+examples/SLSQP.out
+
+# Log files
+*.log
+
+# Temp files in convert test
+tests/v3_to_v4_convert_test/convert_turbine_v3_to_v4.py
+tests/v3_to_v4_convert_test/convert_floris_input_v3_to_v4.py
+tests/v3_to_v4_convert_test/gch_v4.yaml
+tests/v3_to_v4_convert_test/nrel_5MW_v3_v4.yaml

rafmudaf_floris-3.3.post1.dev316/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-executables-have-shebangs
+  - id: check-yaml
+    args: [--unsafe]
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: mixed-line-ending
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.9.6
+  hooks:
+  - id: ruff
+
+- repo: https://github.com/timothycrosley/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort
+    stages: [commit]