Skip to content

Commit

Permalink
Add conda install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mvdh7 committed Feb 19, 2024
1 parent f19e4ee commit 242acb6
Showing 3 changed files with 30 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -8,16 +8,20 @@
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

**Contents:**
<!-- TOC -->

- [PyCO2SYS](#pyco2sys)
- [Introduction](#introduction)
- [Citation](#citation)
- [Installation](#installation)
- [Documentation](#documentation)
- [Basic use](#basic-use)
- [About](#about)
- [License](#license)
- [Introduction](#introduction)
- [Citation](#citation)
- [Installation](#installation)
- [With pip](#with-pip)
- [With conda/mamba](#with-condamamba)
- [Documentation](#documentation)
- [Basic use](#basic-use)
- [About](#about)
- [License](#license)

<!-- /TOC -->

## Introduction

@@ -48,14 +52,22 @@ As per the instructions in the [the CO2SYS-MATLAB repo](https://github.com/james

If you manage Python with conda, we recommend that you first install NumPy, pandas and xarray into the environment where PyCO2SYS is to be installed with conda.

Then, you can install from the Python Package Index:
### With pip

Install from the [Python Package Index](https://pypi.org/project/PyCO2SYS/):

pip install PyCO2SYS

Update an existing installation:

pip install PyCO2SYS --upgrade --no-cache-dir

### With conda/mamba

Install from the [conda-forge channel](https://anaconda.org/conda-forge/pyco2sys):

conda install PyCO2SYS -c conda-forge

## Documentation

Documentation for the current release, based on the `main` branch, is available at [PyCO2SYS.readthedocs.io](https://pyco2sys.readthedocs.io/en/latest/) and at [mvdh.xyz/PyCO2SYS](https://mvdh.xyz/PyCO2SYS/).
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,8 @@ PyCO2SYS is a Python toolbox for solving the marine carbonate system and calcula

## Installation

### With pip

Install from the [Python Package Index](https://pypi.org/project/PyCO2SYS/):

pip install PyCO2SYS
@@ -12,6 +14,12 @@ Update an existing installation:

pip install PyCO2SYS --upgrade --no-cache-dir

### With conda/mamba

Install from the [conda-forge channel](https://anaconda.org/conda-forge/pyco2sys):

conda install PyCO2SYS -c conda-forge

## Basic use

The import convention for PyCO2SYS is:
1 change: 1 addition & 0 deletions docs/versions.md
Original file line number Diff line number Diff line change
@@ -52,6 +52,7 @@ Adds atmospheric pressure input for *p*CO<sub>2</sub>-*f*CO<sub>2</sub>-*x*CO<su
***Technical***

* Updated from building with setup.py to pyproject.toml.
* PyCO2SYS can now be installed with conda/mamba (via conda-forge).

### 1.8.2 (19 January 2023)

0 comments on commit 242acb6

Please sign in to comment.