Skip to content

DOC: update external links #160

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: update external links #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
eofs - EOF analysis in Python
=============================

[![DOI (paper)](https://img.shields.io/badge/DOI%20%28paper%29-10.5334%2Fjors.122-blue.svg)](http://doi.org/10.5334/jors.122) [![DOI (latest release)](https://zenodo.org/badge/20448/ajdawson/eofs.svg)](https://zenodo.org/badge/latestdoi/20448/ajdawson/eofs)
[![DOI (paper)](https://img.shields.io/badge/DOI%20%28paper%29-10.5334%2Fjors.122-blue.svg)](https://doi.org/10.5334/jors.122) [![DOI (latest release)](https://zenodo.org/badge/20448/ajdawson/eofs.svg)](https://zenodo.org/badge/latestdoi/20448/ajdawson/eofs)


Overview
Expand All @@ -22,28 +22,28 @@ Requirements
------------

eofs only requires the NumPy package (and setuptools to install).
In order to use the meta-data preserving interfaces one (or both) of [iris](http://scitools.org.uk/iris) or [xarray](http://xarray.pydata.org) is needed.
In order to use the meta-data preserving interfaces one (or both) of [iris](https://scitools-iris.readthedocs.io) or [xarray](https://docs.xarray.dev/en/stable) is needed.


Documentation
-------------

Documentation is available [online](http://ajdawson.github.io/eofs).
Documentation is available [online](https://ajdawson.github.io/eofs).
The package docstrings are also very complete and can be used as a source of reference when working interactively.


Citation
--------

If you use eofs in published research, please cite it by referencing the [peer-reviewed paper](http://doi.org/10.5334/jors.122).
You can additionally cite the [Zenodo DOI](http://dx.doi.org/10.5281/zenodo.46871) 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).
If you use eofs in published research, please cite it by referencing the [peer-reviewed paper](https://doi.org/10.5334/jors.122).
You can additionally cite the [Zenodo DOI](https://dx.doi.org/10.5281/zenodo.46871) 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).


Installation
------------

eofs works on Python 3 on Linux, Windows or MacOS.
The easiest way to install eofs is by using [conda](http://conda.pydata.org/docs/) or pip:
The easiest way to install eofs is by using [conda](https://docs.conda.io/en/latest/) or pip:

conda install -c conda-forge eofs

Expand Down
2 changes: 1 addition & 1 deletion doc/_themes/sphinx13/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


{% block extrahead %}
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400,700'
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300,400,700'
rel='stylesheet' type='text/css' />
{{ super() }}
{%- if not embedded %}
Expand Down
4 changes: 2 additions & 2 deletions doc/devguide/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ This will run the tests on the version of `eofs` you just installed.

.. _pytest: https://docs.pytest.org/en/latest/

.. _iris: http://scitools.org.uk/iris
.. _iris: https://scitools-iris.readthedocs.io

.. _xarray: http://xarray.pydata.org
.. _xarray: https://docs.xarray.dev/en/stable
4 changes: 2 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ If you would like to contribute code or documentation please see the :doc:`devgu

.. _dask: https://www.dask.org/

.. _iris: http://scitools.org.uk/iris
.. _iris: https://scitools-iris.readthedocs.io

.. _xarray: http://xarray.pydata.org
.. _xarray: https://docs.xarray.dev/en/stable

.. _numpy: https://numpy.org/

Expand Down
6 changes: 3 additions & 3 deletions examples/iris/hgt_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions examples/iris/sst_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,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 cartopy.crs as ccrs
Expand Down
6 changes: 3 additions & 3 deletions examples/standard/hgt_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions examples/standard/sst_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,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
Expand Down
6 changes: 3 additions & 3 deletions examples/xarray/hgt_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/en/stable)
* matplotlib (https://matplotlib.org/)
* cartopy (https://cartopy.readthedocs.io/)

"""
import cartopy.crs as ccrs
Expand Down
6 changes: 3 additions & 3 deletions examples/xarray/sst_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,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/en/stable)
* matplotlib (https://matplotlib.org/)
* cartopy (https://cartopy.readthedocs.io/)

"""
import cartopy.crs as ccrs
Expand Down