diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 03c74a3..3b18e55 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -39,3 +39,8 @@ jobs: with: project-token: ${{ secrets.CODACY_PROJECT_TOKEN }} coverage-reports: coverage.xml + + - name: Install documentation dependencies + if: ${{ always() }} + run: | + if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi diff --git a/README.md b/README.md index e1374a6..c28aa44 100644 --- a/README.md +++ b/README.md @@ -42,29 +42,29 @@ $^a$ $T_{max}$ and $T_{min}$ can also be provided. $^b$ $RH_{max}$ and $RH_{min} Examples of using *pyet* can be found in the example folder: -* [Example 1](docs/examples/01_example_zamg.ipynb): Estimating PET using pandas.Series +* [Example 1](): Estimating PET using pandas.Series -* [Example 2](docs/examples/02_example_zamg_netcdf.ipynb): Estimating PET using xarray.DataArray +* [Example 2](): Estimating PET using xarray.DataArray -* [Example 3](docs/examples/03_example_knmi.ipynb): Benchmarking Makkink +* [Example 3](): Benchmarking Makkink against [KNMI data](https://www.knmi.nl/over-het-knmi/about) -* [Example 4](docs/examples/04_example_coagmet.ipynb): Benchmarking FAO56 +* [Example 4](): Benchmarking FAO56 against [CoAgMET data](https://coagmet.colostate.edu/) -* [Example 5](docs/examples/05_example_calibration.ipynb): Calibrating the Romanenko and Abtew method against the PM-FAO56 +* [Example 5](): Calibrating the Romanenko and Abtew method against the PM-FAO56 -* [Example 6](docs/examples/06_worked_examples_McMahon_etal_2013.ipynb): Worked examples for estimating meteorological +* [Example 6](): Worked examples for estimating meteorological variables and potential evapotranspiration after McMahon et al., 2013 -* [Example 7](docs/examples/07_example_climate_change.ipynb): Example for estimating potential evapotranspiration under +* [Example 7](): Example for estimating potential evapotranspiration under warming and elevated $CO_2$ concentrations following Yang et al., (2019) -* [Example 8](docs/examples/08_crop_coefficient.ipynb): Determining the crop coefficient function with Python +* [Example 8](): Determining the crop coefficient function with Python -* [Example 9](docs/examples/09_CMIP6_data.ipynb): Estimating PET using CMIP data +* [Example 9](): Estimating PET using CMIP data -* [Example 10](docs/examples/10_example_paper.ipynb): Notebook supporting PyEt manuscript +* [Example 10](): Notebook supporting PyEt manuscript Documentation is hosted on [ReadTheDocs](https://pyet.readthedocs.io). diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9aa12b3 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,13 @@ +numpy>=1.16 +xarray>=0.18.0 +pandas>=1.2 +flake8 +pytest +matplotlib +netcdf4 +scipy +seaborn +scikit-learn +pylab +mpl_toolkits +spotpy \ No newline at end of file