From 242acb620b9dbbf9a109f6d3f501c31783b79bde Mon Sep 17 00:00:00 2001 From: Matthew Humphreys Date: Mon, 19 Feb 2024 09:10:37 +0100 Subject: [PATCH] Add conda install instructions --- README.md | 30 +++++++++++++++++++++--------- docs/index.md | 8 ++++++++ docs/versions.md | 1 + 3 files changed, 30 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9a6fb719..665730ff 100644 --- a/README.md +++ b/README.md @@ -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:** + - [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) + + ## Introduction @@ -48,7 +52,9 @@ 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 @@ -56,6 +62,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 + ## 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/). diff --git a/docs/index.md b/docs/index.md index 6a328ae9..0d9f9281 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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: diff --git a/docs/versions.md b/docs/versions.md index 88fee12b..34517a7f 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -52,6 +52,7 @@ Adds atmospheric pressure input for *p*CO2-*f*CO2-*x*CO