Skip to content

Commit

Permalink
Update hyperlinks in docs and README
Browse files Browse the repository at this point in the history
  • Loading branch information
ajdawson committed Nov 20, 2024
1 parent 6bcbc22 commit b679769
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 22 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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/20448/ajdawson/windspharm.svg)](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm)
[![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)

Overview
--------
Expand Down
6 changes: 3 additions & 3 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The v1.7.0 release makes further progress on the road to more modern tooling and

* Support for using Legendre functions computed on-the-fly or stored, implemented by `@rcomer <https://github.com/rcomer>`_ [:issue:`97`, :pr:`98`].
* The source code directories have been reorganised, the ``lib/windspharm`` directory has been moved to ``windspharm/`` (``lib/`` is removed) and the ``doc/`` directory has been renamed ``docs/`` [:pr:`105`].
* The package version is now controlled by `versioneer <https://github.com/warner/python-versioneer>`_.
* The package version is now controlled by `versioneer <https://github.com/python-versioneer/python-versioneer>`_.

In addition, this is the first release where documentation and PyPI packages will be built automatically as part of the continuous integration system.

Expand All @@ -35,7 +35,7 @@ v1.6
This release has no major user-facing changes, its main purpose is to modernise the test suite and fix problems with NumPy compatibility, although the modifications to the test suite may have knock-on effects for package maintainers.

* Fixes for NumPy compatibility [:issue:`89`, :pr:`90`].
* Switch from `nose` to `pytest <http://pytest.org>`_ for the test suite [:pr:`91`, :pr:`94`].
* Switch from `nose` to `pytest <https://docs.pytest.org/en/stable/>`_ for the test suite [:pr:`91`, :pr:`94`].


v1.5
Expand All @@ -58,7 +58,7 @@ v1.4
:Release: v1.4.0
:Date: 1 March 2016

* Added an `xarray <http://xarray.pydata.org>`_ interface allowing use of `windspharm` with `xarray.DataArray` objects.
* Added an `xarray <https://xarray.dev>`_ interface allowing use of `windspharm` with `xarray.DataArray` objects.
* Fixed a bug in the identification of Gaussian grids in the iris interface.
* Fixed a bug where the `truncate` method would not work on inverted latitude grids in the iris interface.

Expand Down
6 changes: 3 additions & 3 deletions docs/devguide/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Then create a directory somewhere else without any Python code in it and run ``p
This will run the tests on the version of `windspharm` you just installed.
This also applies when `windspharm` has been installed by another method (e.g., pip or conda).

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

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

.. _xarray: http://xarray.pydata.org
.. _xarray: https://xarray.dev
24 changes: 9 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can also check out the source code for the development version from the `git
Requirements
------------

This package requires as a minimum that you have numpy_ and pyspharm_ available, and requires setuptools_ for installation.
This package requires as a minimum that you have numpy_ and pyspharm_ available.
The `windspharm.iris` interface can only be used if the `iris` package is available (see the iris_ documentation).
The `windspharm.xarray` interface can only be used if the `xarray` package is available (see the xarray_ documentation).

Expand Down Expand Up @@ -94,7 +94,7 @@ Citation
--------

If you use windspharm in published research, please cite it by referencing the `peer-reviewed paper <http://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).
You can additionally cite the `Zenodo DOI <https://zenodo.org/records/1401190>`_ 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).


Developing and Contributing
Expand All @@ -106,22 +106,16 @@ Bug reports and feature requests can be filed using the Github issues_ system.
If you would like to contribute code or documentation please see the :doc:`devguide/index`.


.. _UVCDAT: http://uvcdat.llnl.gov/
.. _iris: https://scitools-iris.readthedocs.io/en/stable

.. _iris: http://scitools.org.uk/iris
.. _xarray: https://xarray.dev

.. _xarray: http://xarray.pydata.org
.. _numpy: https://numpy.org

.. _numpy: http://numpy.scipy.org
.. _pyspharm: https://github.com/jswhit/pyspharm

.. _pyspharm: https://code.google.com/p/pyspharm
.. _issues: https://github.com/ajdawson/windspharm/issues

.. _setuptools: https://pypi.python.org/pypi/setuptools
.. _windspharm: https://ajdawson.github.io/windspharm

.. _issues: http://github.com/ajdawson/windspharm/issues?state=open

.. _windspharm: http://ajdawson.github.com/windspharm

.. _conda: http://conda.pydata.org/docs/

.. _binstar: https://binstar.org
.. _conda: https://github.com/conda-forge/miniforge

0 comments on commit b679769

Please sign in to comment.