Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix Cloud-Drift#106

- added details on how to use the `environment.yml`
- added a note on using the pip package
- added badges for the conda and pip packages
  • Loading branch information
philippemiron authored Feb 18, 2023
1 parent fbaf27a commit ff98efd
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
![CI](https://github.com/Cloud-Drift/clouddrift/workflows/CI/badge.svg)
[![Documentation Status](https://github.com/Cloud-Drift/clouddrift/actions/workflows/docs.yml/badge.svg)](https://cloud-drift.github.io/clouddrift)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Cloud-Drift/clouddrift-examples/main?labpath=notebooks)
[![Available on conda-forge](https://img.shields.io/badge/Anaconda.org-0.6.0-blue.svg)](https://anaconda.org/conda-forge/clouddrift/)
[![Available on pypi](https://img.shields.io/pypi/v/clouddrift.svg?style=flat&color=blue)](https://pypi.org/project/clouddrift/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![NSF-2126413](https://img.shields.io/badge/NSF-2126413-blue.svg)](https://nsf.gov/awardsearch/showAward?AWD_ID=2126413)
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FCloud-Drift%2Fclouddrift&count_bg=%2368C563&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
Expand All @@ -14,20 +16,20 @@ It is funded by [NSF EarthCube](https://www.earthcube.org/info) through the

### Install CloudDrift

You can install the latest release of CloudDrift using pip or Conda.
You can also install the latest development (unreleased) version from GitHub.
You can install the latest release of CloudDrift using pip or conda. Note that using the pip [package](https://pypi.org/project/clouddrift/), you might have to manually install system libraries required by `clouddrift`, e.g. the `libnetcdf4`. As an alternative, using the conda [package](https://anaconda.org/conda-forge/clouddrift) those libraries are automatically installed.

#### pip
#### Latest official release
##### pip

In your virtual environment, type:

```
pip install clouddrift
```

#### Conda
##### Conda

First add `conda-forge` to your channels in your Conda environment:
First add `conda-forge` to your channels in your Conda configuration (`~/.condarc`):

```
conda config --add channels conda-forge
Expand All @@ -42,23 +44,29 @@ conda install clouddrift

#### Development branch

If you need the latest development version, get it from GitHub using pip:
If you need the latest development version, you can install it directly from GitHub.

##### pip

```
pip install git+https://github.com/cloud-drift/clouddrift
```

##### Conda
```
conda env create -f environment.yml
````
with the environment [file](https://github.com/Cloud-Drift/clouddrift/blob/main/environment.yml) located in the main repository.
### Run the tests
To run the tests, you need to first download the CloudDrift source code from
GitHub and install it in your virtual environment:
GitHub and create the required environment:
```
git clone https://github.com/cloud-drift/clouddrift
cd clouddrift
python3 -m venv venv
source venv/bin/activate
pip install .
cd clouddrift/
conda env create -f environment.yml
```
Then, run the tests like this:
Expand Down

0 comments on commit ff98efd

Please sign in to comment.