roms-tools 1.4.2__py3-none-any.whl → 1.6.0__py3-none-any.whl

{roms_tools-1.4.2.dist-info → roms_tools-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 1.4.2
+Version: 1.6.0
 Summary: Tools for running and analysing UCLA-ROMS simulations
 Author-email: Nora Loose <nora.loose@gmail.com>, Thomas Nicholas <tom@cworthy.org>
 License: Apache-2
@@ -34,6 +34,7 @@ Provides-Extra: dask
 Requires-Dist: dask; extra == "dask"
 
 # ROMS-Tools
+[![Conda version](https://img.shields.io/conda/vn/conda-forge/roms-tools.svg)](https://anaconda.org/conda-forge/roms-tools)
 [![PyPI version](https://img.shields.io/pypi/v/roms-tools.svg)](https://pypi.org/project/roms-tools/)
 [![codecov](https://codecov.io/gh/CWorthy-ocean/roms-tools/graph/badge.svg?token=5S1oNu39xE)](https://codecov.io/gh/CWorthy-ocean/roms-tools)
 [![Documentation Status](https://readthedocs.org/projects/roms-tools/badge/?version=latest)](https://roms-tools.readthedocs.io/en/latest/?badge=latest)
@@ -47,7 +48,15 @@ A suite of python tools for setting up a [ROMS](https://github.com/CESR-lab/ucla
 
 <mark>**DISCLAIMER**: This project is **ALPHA** and will be **EXPERIMENTAL** at least throughout Fall 2024. We do not recommend to use this software before this ALPHA development and test phase is completed.</mark>
 
-## Installation instructions
+## Installation
+
+### Installation from conda forge
+
+```bash
+conda install -c conda-forge roms-tools
+```
+
+This command installs `ROMS-Tools` along with its `dask` dependency.
 
 ### Installation from pip
 
@@ -75,7 +84,7 @@ Next, install and activate the following conda environment:
 
 ```bash
 conda env create -f ci/environment.yml
-conda activate romstools
+conda activate romstools-test
 ```
 
 Finally, install `ROMS-Tools` in the same environment:
@@ -97,7 +106,7 @@ pip install -e .[dask]
 Before running the tests, you can activate the conda environment created in the previous section:
 
 ```bash
-conda activate romstools
+conda activate romstools-test
 ```
 
 Check the installation of `ROMS-Tools` has worked by running the test suite