diff --git a/README.md b/README.md index b3df0be..1db4bed 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ windspharm - spherical harmonic vector wind analysis in Python ============================================================== -[![DOI (paper)](https://img.shields.io/badge/DOI%20%28paper%29-10.5334%2Fjors.129-blue.svg)](http://doi.org/10.5334/jors.129) [![DOI (latest release)](https://zenodo.org/badge/4715033.svg)](https://zenodo.org/records/1401190) +[![DOI (paper)](https://img.shields.io/badge/DOI%20%28paper%29-10.5334%2Fjors.129-blue.svg)](https://doi.org/10.5334/jors.129) [![DOI (latest release)](https://zenodo.org/badge/4715033.svg)](https://zenodo.org/records/1401190) Overview -------- @@ -17,20 +17,20 @@ windspharm provides a replacement for the windfield package from CDAT. Requirements ------------ -`windspharm` only requires [`numpy`](http://numpy.org) and [`pyspharm`](https://github.com/jswhit/pyspharm) (version 1.0.9 or higher), but for full functionality (meta-data interfaces) one or both of [`iris`](http://scitools.org.uk/iris/) and/or [`xarray`](http://xarray.pydata.org) are required. +`windspharm` only requires [`numpy`](https://numpy.org) and [`pyspharm`](https://github.com/jswhit/pyspharm) (version 1.0.9 or higher), but for full functionality (meta-data interfaces) one or both of [`iris`](https://scitools-iris.readthedocs.io/) and/or [`xarray`](https://docs.xarray.dev) are required. Documentation ------------- -Documentation is available [online](http://ajdawson.github.io/windspharm). +Documentation is available [online](https://ajdawson.github.io/windspharm). The package docstrings are also very complete and can be used as a source of reference when working interactively. Citation -------- -If you use windspharm in published research, please cite it by referencing the [peer-reviewed paper](http://doi.org/10.5334/jors.129). +If you use windspharm in published research, please cite it by referencing the [peer-reviewed paper](https://doi.org/10.5334/jors.129). You can additionally cite the [Zenodo DOI](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm) if you need to cite a particular version (but please also cite the paper, it helps me justify my time working on this and similar projects). @@ -48,7 +48,7 @@ Frequently asked questions Installation ------------ -The easiest way to install is via [conda](http://conda.pydata.org): +The easiest way to install is via [conda](https://docs.conda.io): conda install -c conda-forge windspharm diff --git a/docs/_themes/sphinx13_mod/layout.html b/docs/_themes/sphinx13_mod/layout.html index a80b41a..e426e9c 100644 --- a/docs/_themes/sphinx13_mod/layout.html +++ b/docs/_themes/sphinx13_mod/layout.html @@ -16,7 +16,7 @@ {% block extrahead %} - {{ super() }} {%- if not embedded %} diff --git a/docs/index.rst b/docs/index.rst index 2346f68..12fdb4d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,7 +93,7 @@ The following is a very simple illustrative example which computes the streamfun Citation -------- -If you use windspharm in published research, please cite it by referencing the `peer-reviewed paper `_. +If you use windspharm in published research, please cite it by referencing the `peer-reviewed paper `_. You can additionally cite the `Zenodo DOI `_ if you need to cite a particular version (but please also cite the paper, it helps me justify my time working on this and similar projects). diff --git a/examples/iris/rws_example.py b/examples/iris/rws_example.py index 3b4ee02..98d1a5d 100644 --- a/examples/iris/rws_example.py +++ b/examples/iris/rws_example.py @@ -4,9 +4,9 @@ Additional requirements for this example: -* iris (http://scitools.org.uk/iris/) -* matplotlib (http://matplotlib.org/) -* cartopy (http://scitools.org.uk/cartopy/) +* iris (https://scitools-iris.readthedocs.io/) +* matplotlib (https://matplotlib.org/) +* cartopy (https://cartopy.readthedocs.io/) """ import warnings diff --git a/examples/iris/sfvp_example.py b/examples/iris/sfvp_example.py index 7146655..99fdb92 100644 --- a/examples/iris/sfvp_example.py +++ b/examples/iris/sfvp_example.py @@ -6,9 +6,9 @@ Additional requirements for this example: -* iris (http://scitools.org.uk/iris/) -* matplotlib (http://matplotlib.org/) -* cartopy (http://scitools.org.uk/cartopy/) +* iris (https://scitools-iris.readthedocs.io/) +* matplotlib (https://matplotlib.org/) +* cartopy (https://cartopy.readthedocs.io/) """ import warnings diff --git a/examples/standard/rws_example.py b/examples/standard/rws_example.py index dec8e81..ba58df3 100644 --- a/examples/standard/rws_example.py +++ b/examples/standard/rws_example.py @@ -4,9 +4,9 @@ Additional requirements for this example: -* netCDF4 (http://unidata.github.io/netcdf4-python/) -* matplotlib (http://matplotlib.org/) -* cartopy (http://scitools.org.uk/cartopy/) +* netCDF4 (https://unidata.github.io/netcdf4-python/) +* matplotlib (https://matplotlib.org/) +* cartopy (https://cartopy.readthedocs.io/) """ import cartopy.crs as ccrs diff --git a/examples/standard/sfvp_example.py b/examples/standard/sfvp_example.py index cef6dbd..28223f7 100644 --- a/examples/standard/sfvp_example.py +++ b/examples/standard/sfvp_example.py @@ -6,9 +6,9 @@ Additional requirements for this example: -* netCDF4 (http://unidata.github.io/netcdf4-python/) -* matplotlib (http://matplotlib.org/) -* cartopy (http://scitools.org.uk/cartopy/) +* netCDF4 (https://unidata.github.io/netcdf4-python/) +* matplotlib (https://matplotlib.org/) +* cartopy (https://cartopy.readthedocs.io/) """ import cartopy.crs as ccrs diff --git a/examples/xarray/rws_example.py b/examples/xarray/rws_example.py index 37ddbca..dbcd858 100644 --- a/examples/xarray/rws_example.py +++ b/examples/xarray/rws_example.py @@ -4,9 +4,9 @@ Additional requirements for this example: -* xarray (http://xarray.pydata.org) -* matplotlib (http://matplotlib.org/) -* cartopy (http://scitools.org.uk/cartopy/) +* xarray (https://docs.xarray.dev) +* matplotlib (https://matplotlib.org/) +* cartopy (https://cartopy.readthedocs.io/) """ import cartopy.crs as ccrs diff --git a/examples/xarray/sfvp_example.py b/examples/xarray/sfvp_example.py index 3eca88c..1c5be03 100644 --- a/examples/xarray/sfvp_example.py +++ b/examples/xarray/sfvp_example.py @@ -6,9 +6,9 @@ Additional requirements for this example: -* xarray (http://xarray.pydata.org) -* matplotlib (http://matplotlib.org/) -* cartopy (http://scitools.org.uk/cartopy/) +* xarray (https://docs.xarray.dev) +* matplotlib (https://matplotlib.org/) +* cartopy (https://cartopy.readthedocs.io/) """ import cartopy.crs as ccrs