Skip to content
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.

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

Changes to prepare for a v2 release #155

Merged
merged 15 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
environment-name: TEST
init-shell: bash
create-args: >-
python=3 pip iris xarray cdms2 genutil cdutil sphinx sphinx-issues --channel conda-forge
python=3 pip iris xarray sphinx sphinx-issues --channel conda-forge

- name: Install eofs
shell: bash -l {0}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests-standard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.9", "3.10", "3.11", "3.12"]
os: [windows-latest, ubuntu-latest, macos-latest]
fail-fast: false

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10"]
python-version: ["3.9", "3.10", "3.11", "3.12"]
os: [ubuntu-latest, macos-latest]
fail-fast: false

Expand All @@ -23,7 +23,7 @@ jobs:
environment-name: TEST
init-shell: bash
create-args: >-
python=${{ matrix.python-version }} pip pytest iris xarray cdms2 genutil cdutil --channel conda-forge
python=${{ matrix.python-version }} pip pytest iris xarray --channel conda-forge

- name: Install eofs
shell: bash -l {0}
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
eofs - EOF analysis in Python
=============================

[![Build Status](https://travis-ci.org/ajdawson/eofs.svg?branch=master)](https://travis-ci.org/ajdawson/eofs) [![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)](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)


Overview
Expand All @@ -14,15 +14,15 @@ Some of the key features are listed below:

* Suitable for large data sets: computationally efficient for the large data sets typical of modern climate model output.
* Transparent handling of missing values: missing values are removed automatically when computing EOFs and re-inserted into output fields.
* Meta-data preserving interfaces (optional): works with the iris data analysis package, xarray, or the cdms2 module (from UV-CDAT) to carry meta-data over from input fields to output.
* Meta-data preserving interfaces (optional): works with the iris data analysis package or xarray to carry meta-data over from input fields to output.
* No Fortran dependencies: written in Python using the power of NumPy, no compilers required.


Requirements
------------

eofs only requires the NumPy package (and setuptools to install).
In order to use the meta-data preserving interfaces one (or more) of cdms2 (part of [UV-CDAT](http://uvcdat.llnl.gov/)), [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](http://scitools.org.uk/iris) or [xarray](http://xarray.pydata.org) is needed.


Documentation
Expand All @@ -42,7 +42,7 @@ You can additionally cite the [Zenodo DOI](http://dx.doi.org/10.5281/zenodo.4687
Installation
------------

eofs works on Python 2 or 3 on Linux, Windows or OSX.
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:

conda install -c conda-forge eofs
Expand All @@ -59,6 +59,6 @@ You can also install from the source distribution:
Frequently asked questions
--------------------------

* **Do I need UV-CDAT/cdms2, iris or xarray to use eofs?**
* **Do I need iris or xarray to use eofs?**
No. All the computation code uses NumPy only.
The cdms2 module, iris and xarray are only required for the meta-data preserving interfaces.
The iris and xarray modules are only required for the meta-data preserving interfaces.
9 changes: 0 additions & 9 deletions doc/api/eofs.cdms.rst

This file was deleted.

9 changes: 0 additions & 9 deletions doc/api/eofs.multivariate.cdms.rst

This file was deleted.

11 changes: 5 additions & 6 deletions doc/api/eofs.tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,15 @@
:members:


`eofs.tools.cdms`
`eofs.tools.iris`
-----------------

.. automodule:: eofs.tools.cdms
.. automodule:: eofs.tools.iris
:members:


`eofs.tools.iris`
-----------------
`eofs.tools.xarray`
-------------------

.. automodule:: eofs.tools.iris
.. automodule:: eofs.tools.xarray
:members:

4 changes: 0 additions & 4 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@ Available EOF solvers
:nosignatures:

eofs.standard.Eof
eofs.cdms.Eof
eofs.iris.Eof
eofs.xarray.Eof
eofs.multivariate.standard.MultivariateEof
eofs.multivariate.cdms.MultivariateEof
eofs.multivariate.iris.MultivariateEof


Expand All @@ -26,10 +24,8 @@ Full documentation
:maxdepth: 1

eofs.standard
eofs.cdms
eofs.iris
eofs.xarray
eofs.tools
eofs.multivariate.standard
eofs.multivariate.cdms
eofs.multivariate.iris
Binary file removed doc/devguide/gitwash/branch_dropdown.png
Binary file not shown.
158 changes: 0 additions & 158 deletions doc/devguide/gitwash/configure_git.rst

This file was deleted.

Loading
Loading