Skip to content

Commit

Permalink
Merge pull request #136 from DassHydro/doc-clean-user-guide-and-repo
Browse files Browse the repository at this point in the history
DOC: Clean user guide and repo
  • Loading branch information
inoelloc authored Jan 29, 2024
2 parents 194dff7 + 3c043eb commit d0239ff
Show file tree
Hide file tree
Showing 33 changed files with 33 additions and 22 deletions.
Binary file removed doc/mesh.hdf5
Binary file not shown.
Binary file removed doc/model.hdf5
Binary file not shown.
13 changes: 0 additions & 13 deletions doc/setup.yaml

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
8 changes: 8 additions & 0 deletions doc/source/user_guide/classical_uses/lez_regionalization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ Six physical descriptors are considered in this example, which are:
We can open a Python interface in the **conda environment**. The current working directory will be assumed to be the directory where
the ``Lez-dataset`` is located.

Activate the environment:

.. code-block:: shell
conda activate smash
Open a Python interface:

.. code-block:: shell
(smash) python3
Expand Down
18 changes: 9 additions & 9 deletions doc/source/user_guide/quickstart/cance_first_simulation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spatial scale of 1km², and because it is well modeled with a low complexity app

- provide an overview of the input data required for modelling with `smash`,

- explain how to perform in Python a simulation and a simple model optimization from discharge data at a given gauging station.
- explain how to perform in Python a simulation and a simple model optimization from discharge data at a given gauging station.

.. image:: ../../_static/cance.png
:width: 600
Expand Down Expand Up @@ -107,17 +107,17 @@ the data is the observed discharge in **cubic meter per second** and any negativ

.. note::

It is not necessary to provide an exact observed discharge series for each simulation time step. It is possible to provide a chronicle on a larger time window over which `smash` will only read the lines corresponding to dates after the starting date provided in the header.
It is not necessary to provide an exact observed discharge series for each simulation time step. It is possible to provide a chronicle on a larger time window over which `smash` will only read the lines corresponding to dates after the starting date provided in the header.

Now that a brief tour of the necessary data has been done, we can open a Python interface in the **conda environment**. The current working directory
will be assumed to be the directory where the ``Cance-dataset`` is located.

Activate the environment:

.. code-block:: none
conda activate smash
.. code-block:: shell
conda activate smash
Open a Python interface:

.. code-block:: shell
Expand Down Expand Up @@ -461,14 +461,14 @@ Or masked on the active cells of the catchment

.. ipython:: python
my_prcp = np.where(
ma_prcp = np.where(
model.mesh.active_cell == 0,
np.nan,
model.atmos_data.prcp[..., 1200]
)
plt.imshow(my_prcp);
plt.imshow(ma_prcp);
plt.colorbar(label="Precipitation ($mm/h$)");
@savefig user_guide.quickstart.cance_first_simulation.my_prcp.png
@savefig user_guide.quickstart.cance_first_simulation.ma_prcp.png
plt.title("Masked precipitation");
The spatial average of precipitation (``mean_prcp``) and potential evapotranspiration (``mean_pet``) over each gauge are also computed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ optimization beforehand.
We can open a Python interface in the **conda environment**. The current working directory will be assumed to be the directory where
the ``France-dataset`` is located.

Activate the environment:

.. code-block:: shell
conda activate smash
Open a Python interface:

.. code-block:: shell
(smash) python3
Expand Down
8 changes: 8 additions & 0 deletions doc/source/user_guide/quickstart/lez_split_sample_test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ Now a folder called ``Lez-dataset`` should be accessible and contain the followi
We can open a Python interface in the **conda environment**. The current working directory will be assumed to be the directory where
the ``Lez-dataset`` is located.

Activate the environment:

.. code-block:: shell
conda activate smash
Open a Python interface:

.. code-block:: shell
(smash) python3
Expand Down

0 comments on commit d0239ff

Please sign in to comment.