diff --git a/README.rst b/README.rst index eaa349df..a851e1d0 100644 --- a/README.rst +++ b/README.rst @@ -1,41 +1,60 @@ -hydroMT-sfincs: sfincs plugin for hydroMT -########################################### +hydroMT-sfincs: SFINCS plugin for hydroMT +######################################### -FIXME add badges with correct links +.. image:: https://codecov.io/gh/Deltares/hydromt_sfincs/branch/main/graph/badge.svg + :target: https://codecov.io/gh/Deltares/hydromt_sfincs -.. note:: +.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg + :target: https://deltares.github.io/hydromt_sfincs/latest + :alt: Latest developers docs - This minimal branch from the hydromt_sfincs plugin can be used as a **template** to easily - implement new plugins for hydroMT. To implement a new model do: - - - replace all instances of `plugin` with the model name - - edit license (default GPLv3) - - edit model class (plugin.py) to be adapted for the new model - - check and fix git installation (including pyproject.toml) including entry point - - test "hydromt --models" - - edit installation guide - - edit .github actions and envs/hydromt-plugin.yml environment - - edit template documentation +.. image:: https://img.shields.io/badge/docs-stable-brightgreen.svg + :target: https://deltares.github.io/hydromt_sfincs/stable + :alt: Stable docs last release + +.. image:: https://pypip.in/v/hydromt_sfincs/badge.png + :target: https://pypi.org/project/hydromt_sfincs/ + :alt: Latest PyPI version + +.. image:: https://mybinder.org/badge_logo.svg + :target: https://mybinder.org/v2/gh/Deltares/hydromt_sfincs/main?urlpath=lab/tree/examples hydroMT_ is a python package, developed by Deltares, to build and analysis hydro models. It provides a generic model api with attributes to access the model schematization, (dynamic) forcing data, results and states. This plugin provides an implementation -for the sfincs model. +for the SFINCS_ model. .. _hydromt: https://deltares.github.io/hydromt +.. _SFINCS: https://sfincs.readthedocs.io/en/latest/ Installation ------------ -FIXME installation guide +hydroMT-sfincs is availble from pypi and we are working on adding a release from conda-forge (ongoing). + +To install hydromt_sfincs using pip do: + +.. code-block:: console + + pip install hydromt_sfincs + +We recommend installing a hydromt-sfincs environment including the hydromt_sfincs package +based on the environment.yml file. This environment will install all package dependencies +including the core of hydroMT_. + +.. code-block:: console + + conda env create -f binder/environment.yml + conda activate hydromt-sfincs + pip install hydromt_sfincs Documentation ------------- -Learn more about hydroMT in its `online documentation `_ +Learn more about the hydroMT_sfincs plugin in its `online documentation `_ Contributing ------------