Skip to content

Commit

Permalink
Update README.md (#46)
Browse files Browse the repository at this point in the history
* Update README.md

* remove dask < 2 from upstream ci env

* I removed the wrong dependency.

* This should be the right one
  • Loading branch information
Julius Busecke committed Jan 29, 2020
1 parent 5010d34 commit fc04800
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,18 @@ This package contains a variety of utility functions I have used in the past few
Please be aware that I am currently refactoring a lot of the code, which might cause breaking changes.

Hopefully soon it will be better tested and documented.

## Installation

To install from source use pip:

`pip install git+https://github.com/jbusecke/xarrayutils.git`


## Contents (not complete yet)

### Converting between vertical coordinate systems

`xarrayutils.vertical_coordinates` provides several tool to move between various vertical ocean grids, e.g. z, density, sigma or hybrid coordinates. See [this notebook](https://github.com/jbusecke/xarrayutils/blob/master/doc/vertical_coords.ipynb) for an early example.


3 changes: 1 addition & 2 deletions ci/environment-py37-upstream_master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ channels:
- conda-forge
dependencies:
- python=3.7
- dask < 2 #remove this once upstream problem
# (https://github.com/pydata/xarray/issues/3574) is fixed
- dask
- numpy
- pytest
- future
Expand Down
3 changes: 1 addition & 2 deletions ci/environment-py37.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ channels:
dependencies:
- python=3.7
- xarray < 0.14
- dask < 2 #remove this once upstream problem
# (https://github.com/pydata/xarray/issues/3574) is fixed
- dask < 2
- numpy
- pytest
- future
Expand Down

0 comments on commit fc04800

Please sign in to comment.