Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix readmerst #39

Merged
merged 1 commit into from
May 25, 2020
Merged

Fix readmerst #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
pyDeltaRCM_WMT
**************


.. image:: https://api.travis-ci.com/DeltaRCM/pyDeltaRCM_WMT.svg?branch=develop
:target: https://travis-ci.com/DeltaRCM/pyDeltaRCM_WMT

.. image:: https://coveralls.io/repos/github/DeltaRCM/pyDeltaRCM_WMT/badge.svg?branch=develop
:target: https://coveralls.io/github/DeltaRCM/pyDeltaRCM_WMT?branch=develop


pyDeltaRCM is the Python version of the [Matlab deltaRCM](http://csdms.colorado.edu/wiki/Model:DeltaRCM) model by Man Liang.
pyDeltaRCM is the Python version of the `Matlab deltaRCM <https://csdms.colorado.edu/wiki/Model:DeltaRCM>`_ model by Man Liang.
The pyDeltaRCM scripts in this repository can be run as a stand-alone model following the instructions below.


Expand All @@ -26,19 +25,21 @@ Installation

To install this package into an existing Python 3.x environment, download or clone the repository and run:

.. code::bash
.. code:: bash
$ python setup.py install
Or for a developer installation run:

.. code::bash
.. code:: bash
$ pip install -e .
Executing the model
###################

We recommend you check out our **`pyDeltaRCM in 10 minutes tutorial <https://deltarcm.org/pyDeltaRCM_WMT/guides/10min.html>`_**, which is part of our documentation.
We recommend you check out our `pyDeltaRCM in 10 minutes tutorial <https://deltarcm.org/pyDeltaRCM_WMT/guides/10min.html>`_, which is part of our documentation.

Additionally, the model can be run with example script ``run_pyDeltaRCM.py``:

Expand Down