Restructuring (#200)

* Building and editing a model with the modeller interface - Stukje 'setting up the 3Di Models and Simulations toegevoegd'. Ik twijfel wel over de naam van dit stukje Tutorial 1 - Ik heb een aantal verwijzingen toegevoegd. Bijvoorbeeld voor als iemand voor het eerst de models and simulations gebruikt en ze het nog in moeten stellen met hun personalized API Key. Ik heb de introductie wat we in deze tutorial gaan doen, verduidelijkt. Ik vraag mij namelijk af hoeveel een introducerende stukje over de klondike release nou echt toevoegt voor een nieuwe 3di gebruiker die met tutorial 1 aan de slag gaat. Verder vond ik de titel "Adding the schematisation to your QGIS project" een onduidelijke titel, omdat QGIS verder bijna nergens genoemd wordt. Dus die heb ik ook aangepast. Algemeen: heleboel schoonheids foutjes eruit gehaald, zodat de documenten weer helemaal netjes zijn :) * Nieuwe layout van de documentatie gemaakt * structuur documentatie aangepast * Nog verder gegaan met de herstructurering. Begin gemaakt aan de modelling guidelines. Begin gemaakt aan de overviews van de plugins. * overzicht plugins geupdate. kapotte websites verbeterd. Structuur nog wat aangepast * Add checks overview (#204) --------- Co-authored-by: Johanna Lems <[email protected]> Co-authored-by: leendertvanwolfswinkel <[email protected]> Co-authored-by: Eli Sallé <[email protected]>
nens · Apr 17, 2023 · 6ac0766 · 6ac0766
1 parent 12c961b
commit 6ac0766
Show file tree

Hide file tree

Showing 673 changed files with 54,251 additions and 736 deletions.
diff --git a/README.rst b/README.rst
@@ -5,15 +5,15 @@ Let's try to do it with restructuredtext/sphinx!
 
 The released documentation is at https://docs.3di.live/ .
 
-The latest version of master is at https://docs.staging.3di.live/, you can use
+The latest version of master is at https://docs.staging.3di.live/; you can use
 this for checking if the documentation is OK to be released.
 
-Commits are automatically tested on "travis":
-https://travis-ci.com/nens/threedi-docs/, this makes sure all images are there
-and that there are no missing files. Travis also uploads the
+Commits are automatically tested on "github actions":
+https://github.com/nens/threedi-docs/actions; this makes sure all images are there
+and that there are no missing files. Github Actions also uploads the
 documentation. You can check the upload status at
 https://artifacts.lizard.net/ if you want to make sure a release happened
-(note: a full travis build can take up to three minutes).
+(note: a full documentation build can take up to three minutes).
 
 
 Local setup
@@ -36,7 +36,7 @@ Special commands
 ----------------
 
 If the sphinx documentation tells you about a makefile: you can run those
-commands from within docker, too. For example to build the pdf version::
+commands from within docker, too. For example, to build the pdf version::
 
   $ docker-compose run builder make latexpdf
 
@@ -76,6 +76,18 @@ documentation. In the staging documentation, they're visible.
 Any questions: ask Reinout.
 
 
+Schematisation checks list
+--------------------------
+A list of checks currently executed by the modelchecker is in current_schematisation_checks_table.
+As new checks are added to the modelchecker, this table should be updated. To generate a new list,
+install the `threedi-modelchecker <https://github.com/nens/threedi-modelchecker/>`_ (preferably in
+a virtual environment), and run::
+
+    threedi_modelchecker export-checks --format rst --file current_schematisation_checks_table.rst
+
+This will create a new file called ``current_schematisation_checks_table.rst`` in the directory in which
+you run the command, with which you replace the existing ``current_schematisation_checks_table.rst``
+file in the ``source`` directory in this repository.
 
 
 Some commands needed for the OSGEO4W Shell with sphinx
@@ -86,7 +98,7 @@ From the git directory run the following commands::
     pip install sphinx
     sphinx-build threedi-docs\source build
 
-You will recieve some warnings, check them. You are not able to evaluate LateX
+You will receive some warnings; check them. You are not able to evaluate LateX
 formulas this way.
 
 

diff --git a/fix-uppercase-lowercase.py b/fix-uppercase-lowercase.py
@@ -62,6 +62,10 @@ def main():
     did_something1 = fix_image_files()
     did_something2 = fix_image_links()
     if did_something1 or did_something2:
+        print(
+            "ERROR: All image filenames must be lowercase, or the build will fail!" +
+            " Please make all your image filenames lowercase, and then try again."
+        )
         # Exit with an error code.
         sys.exit(1)
 

diff --git a/source/b_ecosystem.rst → oude_documentatie/b_ecosystem.rst b/source/b_ecosystem.rst → oude_documentatie/b_ecosystem.rst
@@ -1,5 +1,5 @@
-Modeller Interface
-^^^^^^^^^^^^^^^^^^
+Modeller Interface (oud)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The Modeller Interface is the interface for the hydrology experts. This interface is used to build models, edit models, start simulations and analyse results. The Modeller Interface is a customised QGIS installation with dedicated plugins for the use of 3Di.
 This setup allows users to benefit of all processing power of QGIS combined with custom made tools supporting 3Di. Since a 3Di schematisation consists of a compact database (currently spatialite format) and rasters users have a great deal of freedom in building their model.

diff --git a/source/c_threedi_portal.rst → oude_documentatie/c_threedi_portal.rst b/source/c_threedi_portal.rst → oude_documentatie/c_threedi_portal.rst
diff --git a/source/d_adding_running_scenario.rst → ...ocumentatie/d_adding_running_scenario.rst b/source/d_adding_running_scenario.rst → ...ocumentatie/d_adding_running_scenario.rst
@@ -12,11 +12,6 @@ You can run an interactive simulation on the Live Site. The Live Site will provi
 When you use the Modeller Interface your results will only be provided after the simulation has finished. The Modeller Interface does provide a more detailed overview where you can enter your scenario information. 
 
 
-.. toctree::
-   :maxdepth: 2
-
-   d_simulate_modeller_interface
-   d_simulate_live_site
 
 
 
diff --git a/source/d_building_a_model.rst → oude_documentatie/d_building_a_model.rst b/source/d_building_a_model.rst → oude_documentatie/d_building_a_model.rst
@@ -8,6 +8,8 @@ The sections below help you with these tasks by listing several requirements, op
 
 Are you a novice 3Di modeller? Please consult :ref:`tutorial1_workflow` or apply for one of our courses (see https://3diwatermanagement.com/training/3di-course/) 
 
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Building a model

diff --git a/source/d_building_w_live_site.rst → oude_documentatie/d_building_w_live_site.rst b/source/d_building_w_live_site.rst → oude_documentatie/d_building_w_live_site.rst
diff --git a/source/d_building_w_modeller_interface.rst → ...tatie/d_building_w_modeller_interface.rst b/source/d_building_w_modeller_interface.rst → ...tatie/d_building_w_modeller_interface.rst
@@ -5,7 +5,7 @@ Building and editing a model with the Modeller Interface
 ===========================================================
 
 Introduction
-^^^^^^^^^^^^^
+-------------
 3Di schematisations are created and edited in the Modeller Interface and then uploaded to the server, where a 3Di model is generated from the schematisation. The Modeller Interface makes it easy to:
 
 * Create new schematisations
@@ -17,6 +17,7 @@ Introduction
 * Download results
 * Analyse results
 
+
 The general workflow is illustrated in this video:
 
 .. raw:: html
@@ -26,36 +27,38 @@ The general workflow is illustrated in this video:
 *In this video we present the workflow from start to finish of the new simplified modelling process.*
 
 
+.. _create_a_new_schematisation:
 
 Create a new schematisation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. figure:: image/d_openplugin.png
-   :alt: Open the 3Di Models and Simulations plugin
-
-.. figure:: image/d_modelsandsimulations.png
-   :alt: Choose New
-
-
-.. figure:: image/d_newschematisation1.png
-   :alt: Choose Schematisation setttings - tab 1
-
-.. figure:: image/d_newschematisation2.png
-   :alt: Choose Schematisation setttings - tab 2   
-
-
-
+----------------------------
+
 
 #. Open the Modeller Interface
 #. Activate the plugin
+
+   .. figure:: image/d_openplugin.png
+      :alt: Open the 3Di Models and Simulations plugin
+
 #. Choose your default folder
 #. Click on the 'New' button
+
+   .. figure:: image/d_modelsandsimulations.png
+      :alt: Choose New
+
 #. Fill in your credentials to login
 #. Choose a name (obligatory) and tags (optional)
 #. If you have rights to more than one organisation, choose the desired organisation
 #. Click 'Next'
+
+   .. figure:: image/d_newschematisation1.png
+      :alt: Choose Schematisation setttings - tab 1
+
 #. Fill in other settings, such as the projection and friction type and simulation timestep
 #. Click 'Create Schematisation'
+
+   .. figure:: image/d_newschematisation2.png
+      :alt: Choose Schematisation setttings - tab 2  
+
 #. If you get errors, please solve them, otherwise you will get a "SUCCESS" message
 
 Congratulations, you have your first commit!
@@ -64,7 +67,7 @@ Congratulations, you have your first commit!
 .. _view_model_results:
 
 View and edit 3Di model schematisation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----------------------------------------
 
 After loading your 3Di model schematisation, there are several ways to inspect your model. We have added the following features to assist you in viewing and editing the model schematisation:
 
@@ -76,11 +79,11 @@ After loading your 3Di model schematisation, there are several ways to inspect y
 
 .. _multiplestyles:
 
-
-**Multiple styles per layer**
+Multiple styles per layer
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
-The multiple styles per layer can help you when analysing your model. The different styles depict aspects of the layer you might be interested in, without cluttering your schematisation with too much information at once. 
+The multiple styles per layer can help you when analyzing your model. The different styles depict aspects of the layer you might be interested in, without cluttering your schematisation with too much information at once. 
 
 To switch between stylings: 1) Right click the layer you are interested in. 2) Hold your mouse over styles and the multiple styles will be shown. 3) Click on the style you want to use. The style with the dot next to it is the active style. The figure below shows an example for selecting a style. 
 
@@ -438,6 +441,7 @@ We have added drop down menus for multiple value attributes in tables. This to a
     :height: 25pc
     :alt: Drop down menu example
 
+
 Immediate validation
 ^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/source/d_checking_model_schematisation.rst → ...tatie/d_checking_model_schematisation.rst b/source/d_checking_model_schematisation.rst → ...tatie/d_checking_model_schematisation.rst
@@ -5,25 +5,12 @@ Checking the model schematisation
 
 It is very useful to check your model schematisation before uploading. It can raise errors and let you solve them early on, or it can raise warnings, which you might want to solve.
 
-*Checking the model schematisation can only be done with toolboxes in QGIS designed for 3Di models, which come pre-installed with the Modeller Interface.
+*Checking the model schematisation can only be done with plugins in QGIS designed for 3Di models, which come pre-installed with the Modeller Interface.
 For information how to download the Modeller Interface or the seperate plugins, please visit* :ref:`3di_instruments_and_downloads`.
 
-.. _3ditoolbox:
-
-Toolbox for working with 3Di models
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The 3Di toolbox is actived by clicking the toolbox icon in the 3Di-Toolbox bar. 
-
-.. figure:: image/d_qgisplugin_activate_toolbox.png 
-    :alt: 3Di Toolbox Bar
-
-
-After clicking the toolbox icon, a new window is opened. Click the arrow next to the *Tools* icon to open the toolbox and view the different tools that are available. 
-
-.. figure:: image/d_qgisplugin_toolbox_window.png 
-    :alt: Toolbox Window
-
+.. todo:: 
+    de schreenshots moeten worden aangepast + de uitleg. En er moet nog verwezen worden naar algemene uitleg plugin.
+
 
 .. _rasterchecker:
 
@@ -70,7 +57,7 @@ This is done for all v2_global_setting rows.
 
 - 11: Are the pixels square?
 
-- 12: Are there no extreme pixel values? (dem: -10kmMSL<x<10kmMSL, other rasters have their own limits
+- 12: Are there no extreme pixel values? (dem: -10kmMSL<x<10kmMSL, other rasters have their own limits)
 
 -- All rasters per setting_id at once: -- 
 
@@ -148,7 +135,7 @@ With the checker you can make sure most database errors are found before sending
 In order to use the *schematisation checker* follow these steps:
 
 1. Start the Modeller Interface
-2. Add a connection to the model database (*Layer* -> *Data Source Manager*, Select *SpatiaLite* on the left and create a *'New’* connection or connect to an existing connection)
+2. Add a connection to the model database (*Layer* -> *Data Source Manager*, Select *SpatiaLite* on the left and create a *'New'* connection or connect to an existing connection)
 3. Open the *schematization checker* by opening the *Toolbox* in the 3Di Plugin, select *Step 1: check data*, select *schematisation_checker.py*
 4. Select the SpatiaLite connection of the model database and the location where to store the output of the schematisation checker. Click *run* to run the schematisation checker. Click *open* to open the output.
 

diff --git a/source/d_livesite_results.rst → oude_documentatie/d_livesite_results.rst b/source/d_livesite_results.rst → oude_documentatie/d_livesite_results.rst
diff --git a/source/d_schematisation_editor.rst → ..._documentatie/d_schematisation_editor.rst b/source/d_schematisation_editor.rst → ..._documentatie/d_schematisation_editor.rst
@@ -133,7 +133,7 @@ Notes on the 3Di Features
 Pasting features from external data sources
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Features can be copy-pasted from external data sources into the schematisation editor. 
-Check out the `QGIS Documentation <https://docs.qgis.org/3.22/en/docs/user_manual/working_with_vector/attribute_table.html>`_ for how to work with the attribute table.
+Check out the `QGIS Documentation <https://docs.qgis.org/3.22/en/docs/user_manual/working_with_vector/attribute_table.html>`__ for how to work with the attribute table.
 
 
 .. Note::
@@ -142,7 +142,7 @@ Check out the `QGIS Documentation <https://docs.qgis.org/3.22/en/docs/user_manua
 
 
 Editing feature attributes
-^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 There are two options to edit feature attributes:
 
     #) Via the attribute table.
@@ -151,7 +151,7 @@ There are two options to edit feature attributes:
 
 Editing feature geometries
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
-For editing the geometries of features, the 'Vertex tool' can be used, see the `QGIS documentation <https://docs.qgis.org/3.22/en/docs/user_manual/working_with_vector/editing_geometry_attributes.html?highlight=vertex%20tool#vertex-tool>`_.
+For editing the geometries of features, the 'Vertex tool' can be used, see the `QGIS documentation <https://docs.qgis.org/3.22/en/docs/user_manual/working_with_vector/editing_geometry_attributes.html?highlight=vertex%20tool#vertex-tool>`__.
 On top of the standard QGIS functionalty, the Schematisation Editor provides extra functionalities:
 
     - When moving a node, all connected features will move along.

diff --git a/source/d_simulate_live_site.rst → oude_documentatie/d_simulate_live_site.rst b/source/d_simulate_live_site.rst → oude_documentatie/d_simulate_live_site.rst
diff --git a/source/d_simulate_modeller_interface.rst → ...entatie/d_simulate_modeller_interface.rst b/source/d_simulate_modeller_interface.rst → ...entatie/d_simulate_modeller_interface.rst
diff --git a/source/d_viewing_analysing_results.rst → ...umentatie/d_viewing_analysing_results.rst b/source/d_viewing_analysing_results.rst → ...umentatie/d_viewing_analysing_results.rst