diff --git a/.github/workflows/lint-and-test.yaml b/.github/workflows/lint-and-test.yaml index 73e3a51..8855a15 100644 --- a/.github/workflows/lint-and-test.yaml +++ b/.github/workflows/lint-and-test.yaml @@ -17,7 +17,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.9", "3.10", "3.11", "3.12"] + python-version: ["3.9", "3.x"] os: [ubuntu-latest] steps: - uses: actions/checkout@v4 @@ -32,7 +32,7 @@ jobs: key: ${{ matrix.python-version }}-venv-${{ hashFiles('**/pyproject.toml') }} restore-keys: | ${{ matrix.python-version }}-venv - - name: 'create virtualenv and install dependencies' + - name: 'create environment and install dependencies' if: steps.cache-venv.outputs.cache-hit != 'true' run: | python -m venv .venv diff --git a/README.md b/README.md index e89743c..5d2372a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # wind-up A tool to assess yield uplift of wind turbines -[![lint-and-test](https://github.com/resgroup/wind-up/actions/workflows/lint-and-test.yaml/badge.svg)](https://github.com/resgroup/wind-up/actions/workflows/lint-and-test.yaml) -[![Python 3.10](https://img.shields.io/badge/python-≥3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/) +[![image](https://img.shields.io/pypi/v/res-wind-up.svg)](https://pypi.python.org/pypi/res-wind-up) +[![image](https://img.shields.io/pypi/l/res-wind-up.svg)](https://github.com/resgroup/wind-up/blob/main/LICENSE.txt) +[![image](https://img.shields.io/pypi/pyversions/res-wind-up.svg)](https://pypi.python.org/pypi/res-wind-up) [![Lint & Format: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff) [![Typing: mypy](https://img.shields.io/badge/typing-mypy-yellow.svg)](https://github.com/python/mypy) -[![TaskRunner: poethepoet](https://img.shields.io/badge/poethepoet-enabled-1abc9c.svg)](https://github.com/nat-n/poethepoet) +[![lint-and-test](https://github.com/resgroup/wind-up/actions/workflows/lint-and-test.yaml/badge.svg)](https://github.com/resgroup/wind-up/actions/workflows/lint-and-test.yaml) ## Getting Started See [`examples`](examples) folder for example analysis using the wind-up package. [`smarteole_example.ipynb`](examples%2Fsmarteole_example.ipynb) is a good place to start. diff --git a/examples/smarteole_example.ipynb b/examples/smarteole_example.ipynb index 9829f37..8a1db7b 100644 --- a/examples/smarteole_example.ipynb +++ b/examples/smarteole_example.ipynb @@ -9,7 +9,7 @@ "Dataset citation:\n", "Thomas Duc, & Eric Simley. (2022). SMARTEOLE Wind Farm Control open dataset (1.0) [Data set]. Zenodo. https://doi.org/10.5281/zenodo.7342466\n", "\n", - "wind-up methodology description: `docs/wind-up uplift validation methodology.pdf`" + "See [wind-up uplift validation methodology.pdf](https://github.com/resgroup/wind-up/blob/define-supported-python/docs/wind-up%20uplift%20validation%20methodology.pdf) for a description of the calculation methodology." ] }, { diff --git a/pyproject.toml b/pyproject.toml index 8b1e71b..2e83e4a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,13 +6,19 @@ authors = [ ] description = "A tool to assess yield uplift of wind turbines" readme = "README.md" -requires-python = ">=3.9" +requires-python = ">=3.9,<4.0" license = { file = "LICENSE.txt" } classifiers = [ "Development Status :: 4 - Beta", - "Programming Language :: Python :: 3", + "Programming Language :: Python", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3 :: Only", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", + "Topic :: Scientific/Engineering" ] dependencies = [ 'eval-type-backport',