diff --git a/source/c_3di_live_sessions.rst b/source/c_3di_live_sessions.rst index a38a0bc9..9e256e7c 100644 --- a/source/c_3di_live_sessions.rst +++ b/source/c_3di_live_sessions.rst @@ -88,10 +88,10 @@ You can: Storing results --------------- -Raw results always stored for 7 days -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. note:: + + :ref:`Raw results` will always be stored for 7 days, even if you choose the option *Quit, don't store results*. -:ref:`Raw results` will always be stored for 7 days, even if you choose the option *Quit, don't store results*. Direct download ^^^^^^^^^^^^^^^ @@ -104,12 +104,7 @@ Store in scenario archive .. note:: This option is only available if your subscription includes the Scenario Archive. -Another option you have when you quit the session, is to store the results in the :ref:`scenario_archive`. When you choose this option, you also have several options for **automated post-processing**. - -.. figure:: image/d3.9_store_results.png - :alt: Storing results - -For an explanation of the available options, see :ref:`scenario_archive`. +Another option you have when you quit the session, is to store the results in the :ref:`scenario_archive`. When you choose this option, you also have several options for **automated post-processing**. For an explanation of the available options, see :ref:`scenario_archive`. .. _live_simulation_template: diff --git a/source/d_scenario_archive.rst b/source/d_scenario_archive.rst index 98f85bb6..89093898 100755 --- a/source/d_scenario_archive.rst +++ b/source/d_scenario_archive.rst @@ -8,9 +8,9 @@ Scenario Archive The Scenario Archive (Lizard) is used to store and view scenarios. -You can access the Scenario Archive here: https://demo.lizard.net/. For instructions on how to use the Scenario Archive, see the `Lizard documentation`_, for example, the sections about finding scenarios in the `Catalog`_, and the section about the `Viewer`_. +You can access the Scenario Archive here: https://demo.lizard.net/. For instructions on how to use the Scenario Archive, see the `Lizard documentation `_, for example, the sections about finding scenarios in the `Catalog `_, and the section about the `Viewer `_. -Scenario's that are stored in the Scenario Archive can also be accessed in the 3Di Modeller Interface, using the `Lizard plugin` +Scenario's that are stored in the Scenario Archive can also be accessed in the 3Di Modeller Interface, using the `Lizard plugin ` A 3Di scenario consists of one or more of the following components: @@ -69,7 +69,24 @@ Rain intensity per calculation cell (mm/h). Rate of rise ^^^^^^^^^^^^ -Rate of rise (m/s), defined by the difference in water level per second. Can be used for flood damage estimations, for example. +Rate of rise (m/s), defined as how fast the water depth rises from 0 to 1.5 m. + +.. math:: + :label: rate_of_rise + + R = \frac{\delta \zeta}{\delta t} + +In which: + +| :math:`\delta \zeta` difference in water depth, fixed to 1.5 - 0 +| :math:`\delta t` time between the cell getting wet (volume > 0) and reaching a water depth of 1.5 m. The water depth is defined as (water level - lowest DEM pixel in the cell) + +Cells that already have a water depth of 1.5 m at the start of the simulation are ignored. + +.. note:: + + This raster is calculated from the :ref:`3dinetcdf`. The temporal resolution (output time step) of this file determines the precision of :math:`\delta t`. + Max flow velocity ^^^^^^^^^^^^^^^^^ @@ -83,8 +100,8 @@ Arrival time ------------ .. todo:: - Hier een stukje voor schrijven. - + + Hier een stukje over schrijven .. _damage_estimation: diff --git a/source/h_gridadmin.rst b/source/h_gridadmin.rst index 7c029733..1e230ad6 100644 --- a/source/h_gridadmin.rst +++ b/source/h_gridadmin.rst @@ -3,4 +3,4 @@ Computational grid file ----------------------- -The :ref:`computational_grid` is stored in a **gridadmin.h5** file. The contents of this file can be viewed in the 3Di Modeller Interface. If you are using Python, use :ref:`threedigrid` to work with this file. \ No newline at end of file +The :ref:`computational_grid` is stored in a **gridadmin.h5** file. The contents of this file can be :ref:`viewed in the 3Di Modeller Interface<3di_results_manager>`. If you are using Python, use :ref:`threedigrid` to work with this file. \ No newline at end of file diff --git a/source/h_water_quality_results.rst b/source/h_water_quality_results.rst index 4d44c50f..5fc25024 100644 --- a/source/h_water_quality_results.rst +++ b/source/h_water_quality_results.rst @@ -3,7 +3,11 @@ Water quality results 3Di ========================= -The water quality results of a simulation are written to a `NetCDF `_ file called *water_quality_results_3di.nc*, which follows the `CF Conventions `_ . The CF convention stipulates that the 2D and 1D mesh data are stored in separate parts of the file. The *water_quality_results_3di.nc* file contains snapshots of concentrations at nodes (1D and 2D). The output timestep, i.e. the interval at which these snapshot values are written to the NetCDF file, is set at the start of the simulation. +The water quality results of a simulation are written to a `NetCDF `_ file called *water_quality_results_3di.nc*. + +Use :ref:`threedigrid` to work with this file. + +The file structure follows the `CF Conventions `_ . The CF convention stipulates that the 2D and 1D mesh data are stored in separate parts of the file. The *water_quality_results_3di.nc* file contains snapshots of concentrations at nodes (1D and 2D). The output timestep, i.e. the interval at which these snapshot values are written to the NetCDF file, is set at the start of the simulation. Water quality results can be retrieved from the nodes in the 1D and 2D. The amount of variables in the netcdf depends on the amount of added substances in the model. An overview of the configuration of the variables is given below. diff --git a/source/i_downloading_results.rst b/source/i_downloading_results.rst index 7f5507eb..9c387464 100644 --- a/source/i_downloading_results.rst +++ b/source/i_downloading_results.rst @@ -11,10 +11,10 @@ There are two options for downloading simulation results: .. _dl_via_models_simulations: -Download via 3Di Models and Simulation panel --------------------------------------------- +Download via 3Di Models and Simulations panel +--------------------------------------------- -Simulation results can be downloaded using the :ref:`models_simulation_panel`, within 7 days after the simulation has finished. To download results: +Simulation results can be downloaded using the :ref:`models_simulation_panel`. To download results: #) Activate the *3Di Models and Simulation panel* by clicking the pictogram (|modelsSimulations|) in the toolbar. #) Click the *Results* icon (|download_results|). @@ -22,8 +22,10 @@ Simulation results can be downloaded using the :ref:`models_simulation_panel`, w The results will be downloaded to your local 3Di working directory, so that you can find them easily when loading them via the :ref:`3Di Resuls Manager<3di_results_manager>` +The files that are downloaded in this way are the :ref:`Raw results`. To download automatically post-processed results, such as maximum water depth rasters, see :ref:`dl_via_lizard_plugin`. + .. note:: - The raw results are only available for 7 days after a simulation has finished. + Results are only available for download from the 3Di Models and Simulations panel for 7 days after a simulation has finished. .. |modelsSimulations| image:: /image/pictogram_modelsandsimulations.png :scale: 90% @@ -31,10 +33,12 @@ The results will be downloaded to your local 3Di working directory, so that you .. |download_results| image:: /image/pictogram_download_results.png :scale: 60% +.. _dl_via_lizard_plugin: + Download via the Lizard plugin ------------------------------ -If you have stored simulation results in the Scenario Archive, you can download them using the `Lizard plugin`_. +If you have stored simulation results in the :ref:`scenario_archive`, you can download them using the `Lizard plugin `_. Instructions for storing simulation results in the Scenario Archive can be found here: diff --git a/source/i_wms_layers.rst b/source/i_wms_layers.rst index f0187e13..a61ff366 100644 --- a/source/i_wms_layers.rst +++ b/source/i_wms_layers.rst @@ -5,4 +5,4 @@ Load results as WMS layers You can add the post-processed results from the :ref:`scenario_archive` to your project as WMS layers, such as maximum water depth maps. This has several advantages: you do not need to download anything, and you can easily view the water depth map for any time step, or see how the water depth map changes over time. -This is easy to do with the Lizard plugin. The documentation for this tool is `part of the Lizard documentation`_ \ No newline at end of file +This is easy to do with the Lizard plugin. The documentation for this tool is `part of the Lizard documentation `_ \ No newline at end of file diff --git a/source/image/d3.9_store_results.png b/source/image/d3.9_store_results.png deleted file mode 100644 index fa0b37e0..00000000 Binary files a/source/image/d3.9_store_results.png and /dev/null differ diff --git a/source/j_threedigrid.rst b/source/j_threedigrid.rst index 8f845cbb..34620b94 100644 --- a/source/j_threedigrid.rst +++ b/source/j_threedigrid.rst @@ -3,4 +3,6 @@ 3Di Results API (threedigrid) ============================= -The Python package "threedigrid" is a Python interface for reading and analyzing 3Di results. It has its own documentation, which can be found `here `_. +The Python package "threedigrid" is a Python interface for reading and analyzing 3Di results. + +threedigrid has its own documentation, which `can be found here `_.