-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,30 @@ | ||
Installation | ||
============ | ||
|
||
At the moment you can install the package via `pip` from | ||
GitHub. Before this, the binary `esmpy` dependency is required. This | ||
is easiest to install using Conda. To do so, first create a custom | ||
Conda environment, or activate an existing environment into which you | ||
want to install `esmpy` and `regional_mom6`. Then install `emspy`: | ||
We can install `regional_mom6` via `pip` from GitHub. A prerequisite of is that the binary `esmpy` | ||
dependency is first installed. The easiest way to install `esmpy` is using Conda. | ||
|
||
First we create a custom Conda environment, or activate an existing environment into which we | ||
will install `esmpy` and `regional_mom6`. Then install `emspy` via: | ||
|
||
```{code-block} bash | ||
conda install -c conda-forge esmpy | ||
``` | ||
|
||
Alternatively, it's possible to follow the [Installing ESMPy from | ||
Source](https://earthsystemmodeling.org/esmpy_doc/release/latest/html/install.html#installing-esmpy-from-source) | ||
instructions to do this in a Conda-free way. With `esmpy` available, you can then install | ||
`regional_mom6` via pip. If your environment doesn't yet have pip, then `conda install pip` should do the job. | ||
Alternatively, to install `esmpy` in a Conda-free way, follow the instructions for [installing ESMPy from | ||
source](https://earthsystemmodeling.org/esmpy_doc/release/latest/html/install.html#installing-esmpy-from-source). | ||
With `esmpy` available, we can then install `regional_mom6` via pip. (If we don't have have pip, then `conda install pip` | ||
should do the job.) | ||
|
||
```{code-block} bash | ||
pip install git+https://github.com/COSIMA/regional-mom6.git | ||
``` | ||
|
||
This will install the latest version of `regional_mom6` plus any required dependencies. | ||
`esmpy` won't be installed as a dependency and that's why need to install it separately. | ||
The above installs the version of `regional_mom6` (plus any required dependencies) that corresponds | ||
to the latest commit in GitHub. `esmpy` won't be installed as a dependency and that's why need to | ||
install it separately. | ||
|
||
Alternatively, you can also install a particular tag or git commit using, e.g., | ||
We can also install `regional_mom6` from a particular tag or git commit using, e.g., | ||
|
||
```{code-block} bash | ||
pip install git+https://github.com/COSIMA/[email protected] | ||
|