Merge pull request #58 from COSIMA/ncc/install

Add installation instructions

README.md

@@ -8,3 +8,39 @@ Users just need to provide some information about where, when, and how big their
 The package sorts out all the boring details and creates a set of MOM6-friendly input files along with setup directories ready to go!
 
 Check out the the [documentation](https://regional-mom6.readthedocs.io/en/latest/) and browse through the [demos](https://regional-mom6.readthedocs.io/en/latest/demos.html).
+
+## 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`:
+
+```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.
+
+```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.
+
+Alternatively, you can also install a particular tag or git commit using, e.g.,
+
+```bash
+pip install git+https://github.com/COSIMA/[email protected]
+```
+
+or
+
+```bash
+pip install git+https://github.com/COSIMA/regional-mom6.git@061b0ef80c7cbc04de0566df329c4ea472002f7e
+```

docs/index.rst

@@ -8,6 +8,7 @@ configurations for the Modular Ocean Model 6
    :maxdepth: 1
    :caption: Contents:
 
+   installation
    contributing
    api
    demos

docs/installation.md

@@ -0,0 +1,36 @@
+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`:
+
+```{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.
+
+```{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.
+
+Alternatively, you can also install a particular tag or git commit using, e.g.,
+
+```{code-block} bash
+pip install git+https://github.com/COSIMA/[email protected]
+```
+
+or
+
+```{code-block} bash
+pip install git+https://github.com/COSIMA/regional-mom6.git@061b0ef80c7cbc04de0566df329c4ea472002f7e
+```