Skip to content

Commit

Permalink
merge download with other chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
Jingru923 committed Sep 3, 2024
1 parent ab6ef0e commit 959262e
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions docs/install.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
title: "Installation"
---

In this document, we describe how to install the Ribasim software package.

# Components {#sec-components}

The figure below illustrates the relation between the various components of the Ribasim software package.

```{mermaid}
Expand Down Expand Up @@ -52,23 +55,28 @@ One can also use Ribasim Python to build entire models from base data, such that

# Download {#sec-download}

- Ribasim executable - Windows: [ribasim_windows.zip](https://github.com/Deltares/Ribasim/releases/latest/download/ribasim_windows.zip)
- Ribasim executable - Linux: [ribasim_linux.zip](https://github.com/Deltares/Ribasim/releases/latest/download/ribasim_linux.zip)
- QGIS plugin: [ribasim_qgis.zip](https://github.com/Deltares/Ribasim/releases/latest/download/ribasim_qgis.zip).
- Generated testmodels: [generated_testmodels.zip](https://github.com/Deltares/Ribasim/releases/latest/download/generated_testmodels.zip)

The Ribasim Python package is [registered in PyPI](https://pypi.org/project/ribasim/) and [conda-forge](https://prefix.dev/channels/conda-forge/packages/ribasim) and can therefore be installed with [pip](https://docs.python.org/3/installing/index.html), [conda](https://docs.conda.io/) or [pixi](https://pixi.sh/):
```
pip install ribasim
```
There are three main components of the Ribasim software package.
They are the Ribasim core (written in Julia language), the Ribasim Python package and the Ribasim QGIS plugin.
The Ribasim core is the computation kernel of the Ribasim software package and is used to run simulations.
The Ribasim Python package is used to build Ribasim models programmatically with Python script.
The Ribasim QGIS plugin is used to construct or view a model in GUI.
Users can choose to use Ribasim Python or QGIS plugin or a combination of them to build a Ribasim model.
And then use the Ribasim core to run the simulation.

# Ribasim core
## Ribasim core

Ribasim is typically used as a command-line interface (CLI). It is distributed as a `.zip`
archive, that must be downloaded and unpacked. It can be placed anywhere, however it is
important that the contents of the zip file are kept together in a directory. The Ribasim
executable is in the main folder.

To download the Ribasim core, download the appropriate zip file for your operating system:

- Ribasim executable - Windows: [ribasim_windows.zip](https://github.com/Deltares/Ribasim/releases/latest/download/ribasim_windows.zip)
- Ribasim executable - Linux: [ribasim_linux.zip](https://github.com/Deltares/Ribasim/releases/latest/download/ribasim_linux.zip)

Note that we currently only support and provide binaries for Windows and Linux, for the x86_64 architecture.

To check whether the installation was performed successfully, open a terminal and go to the path where the executable is for example 'C:\Ribasim\ribasim_windows'.
If you are using cmd.exe type `ribasim`, or for PowerShell `./ribasim`.

Expand All @@ -83,7 +91,7 @@ Usage: ribasim <TOML_PATH>
For more information, try '--help'.'
```

# Ribasim Python
## Ribasim Python

The Ribasim Python package (named `ribasim`) aims to make it easy to build, update and analyze Ribasim models
programmatically.
Expand All @@ -95,23 +103,25 @@ Python instead.
One can also use Ribasim Python to build entire models from base data, such that your model
setup is fully reproducible.

The package is [registered in PyPI](https://pypi.org/project/ribasim/) and can therefore
be installed with [pip](https://docs.python.org/3/installing/index.html):
The Ribasim Python package is [registered in PyPI](https://pypi.org/project/ribasim/) and [conda-forge](https://prefix.dev/channels/conda-forge/packages/ribasim) and can therefore be installed with [pip](https://docs.python.org/3/installing/index.html), [conda](https://docs.conda.io/) or [pixi](https://pixi.sh/):
```
pip install ribasim
```

For documentation please see the [examples](/guide/examples.ipynb) and [API reference](/reference/reference).

# Ribasim QGIS plugin
## Ribasim QGIS plugin

The Ribasim QGIS plugin requires [QGIS](https://qgis.org/en/site/) 3.34 or higher.
The Ribasim QGIS plugin is also distributed as a .zip archive and must be downloaded and installed in QGIS.

## Install Ribasim plugin
### Install Ribasim plugin

Download `ribasim_qgis.zip`, see the [download section](#sec-download).
Firstly, download `ribasim_qgis.zip`:

- QGIS plugin: [ribasim_qgis.zip](https://github.com/Deltares/Ribasim/releases/latest/download/ribasim_qgis.zip).

Plugins menu > Manage and Install Plugins...
In QGIS plugin, go to Plugins menu > Manage and Install Plugins...

![](https://user-images.githubusercontent.com/4471859/224939069-9aae77ea-898f-442f-83b5-f2671c114956.png){fig-align="left"}

Expand All @@ -126,7 +136,7 @@ Open the Ribasim plugin panel.

![](https://user-images.githubusercontent.com/4471859/224939101-228e068a-875b-4df2-98bb-6ee6a3830ddd.png){fig-align="left"}

## Install iMOD plugin
### Install iMOD plugin

In QGIS, navigate to "Plugins > Manage and Install Plugins > All".
In the search bar, type: "iMOD". Select the iMOD plugin, and click "Install".
Expand Down

0 comments on commit 959262e

Please sign in to comment.