Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added windpowerlib Example #236

Merged
merged 2 commits into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions .github/workflows/building-and-installation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ name: Build

# event that triggers workflow
# runs on every pull request
on:
on:
pull_request:
branches:
- main
- main

jobs:
integration-tests:
# specifies the os that the job will run on
# specifies the os that the job will run on
runs-on: ubuntu-latest
strategy:
matrix:
Expand All @@ -18,7 +18,7 @@ jobs:
# downloads the repository code to the runner's file system for workflow access
- uses: actions/checkout@v4

# sets up python environment with specified versions
# sets up python environment with specified versions
- name: Set up python ${{ matrix.python-version }}
id: setup-python
uses: actions/setup-python@v5
Expand All @@ -45,17 +45,17 @@ jobs:
run: poetry build

# install package
- name: Install package
run: pip install dist/*.tar.gz
- name: Install package
run: pip install dist/*.tar.gz

# Install dependencies needed for notebook execution
- name: Install notebook dependencies
run: pip install jupyter nbconvert matplotlib
run: pip install jupyter nbconvert matplotlib windpowerlib

# Execute example notebooks to verify that no errors are thrown
- name: Run Jupyter Notebooks
run: |
notebooks=("examples/signal_example.ipynb" "examples/basic_example.ipynb" "examples/controller_example.ipynb")
notebooks=("examples/signal_example.ipynb" "examples/basic_example.ipynb" "examples/controller_example.ipynb" "examples/stranger_sims_example.ipynb")
for notebook in "${notebooks[@]}"; do
jupyter nbconvert --to notebook --execute "$notebook"
done
done
7 changes: 0 additions & 7 deletions docs/api_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,3 @@ Storage Module
:maxdepth: 2

storage

Power-Meter Module
------------------
.. toctree::
:maxdepth: 2

power_meter
1 change: 1 addition & 0 deletions docs/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Tutorials
basic_example
controller_example
sil_example
stranger_sims_example


.. note::
Expand Down
1 change: 1 addition & 0 deletions docs/tutorials/stranger_sims_example.ipynb
197 changes: 197 additions & 0 deletions examples/stranger_sims_example.ipynb

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ nbsphinx = "*"
pandoc = "*"
ipython = "*"
matplotlib = "*"
windpowerlib = "*"

[build-system]
requires = ["setuptools", "poetry-core>=1.1.0"]
Expand Down
Loading