From 199a34cc15f9b2e7826499610398fd6f2b6204df Mon Sep 17 00:00:00 2001 From: OlofBaltus <112857147+OlofBaltus@users.noreply.github.com> Date: Wed, 21 Feb 2024 14:53:15 +0100 Subject: [PATCH 1/2] Update f_problem_solving.rst --- source/f_problem_solving.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/source/f_problem_solving.rst b/source/f_problem_solving.rst index f2787aaa..d3d3ae29 100644 --- a/source/f_problem_solving.rst +++ b/source/f_problem_solving.rst @@ -8,9 +8,11 @@ Some issues are due to the software, these will be summarised in the section Kno Errors related to input data or other user settings are usually covered by the schematisation checker. In rare cases however they might not catch a potential issue. - :ref:`model_size_limitations` +- :ref:`debug_crashing_model` - :ref:`faq` - :ref:`known_issues` + .. _model_size_limitations: Limitations to model size @@ -48,6 +50,32 @@ Maximum raster size The maximum size of the Digital Elevation Model is 5 billion pixels. This includes NoData pixels. The other rasters will be resampled to the resolution of the DEM, so their pixel count is not relevant. +.. _debug_crashing_model: + +Debug guide crashed Generation & Simulation +------------------------------------------- + +Crashes during model generation and simulations can often be addressed by examining certain variables. It is advisable to explore all available debugging options before submitting a ticket to the service desk. This proactive approach can help resolve issues more efficiently. If the problem persists despite following these recommendations, mentioning that you've already attempted these steps when submitting your ticket to the service desk + +Crash during model generation +^^^^^^^^^^^^^^^^^^^^^^^^ + +- check if the plug-ins in your modeller interface are up to date. If this is not the case, re-run the modelchecker with the updated plug-ins. +- check if your model is within limitations: :ref:`model_size_limitations` +- If the model generation failed on making the simulation template: Check your initial settings in your schematisation including initial (ground)water level raster. + +Crash during simulation +^^^^^^^^^^^^^^^^^^^ + +A few things that are often the cause of crashing simulations have been noted in the list below. Please check these if you encounter crashing simulations. + +- Check if your model up to date. The model generation will always use the latest 3Di framework, but if the 3Di model was generate a long time ago, or there was a new release after the generation of your model, your 3di model can be outdated. You can easily re-generate your model when your model page on the 3di management site. +- It could be that you missed something when uploading your schematisation, when encountering a crashing simulation. You could download your schematisation and run this schematisation again to see if you missed any warnings. + +If these suggestions did not solve your problem, you can try to run your simulation on the livesite. When your model does run on the livesite, it could be that something is wrong with your simulation template. Check this for any weird/wrong settings and restart your simulation. + + + .. _faq: From 2b88380180c41209c72f4f04b0eb36ced29514fd Mon Sep 17 00:00:00 2001 From: leendertvanwolfswinkel Date: Wed, 21 Feb 2024 16:31:28 +0100 Subject: [PATCH 2/2] Review --- source/d_overview_management_portal.rst | 59 ++++++++++++++++++++----- source/f_problem_solving.rst | 33 +++++++------- source/f_servicedesk.rst | 6 ++- source/i_checking_schematisations.rst | 6 +-- 4 files changed, 72 insertions(+), 32 deletions(-) diff --git a/source/d_overview_management_portal.rst b/source/d_overview_management_portal.rst index d06e9751..489dc0a1 100644 --- a/source/d_overview_management_portal.rst +++ b/source/d_overview_management_portal.rst @@ -26,20 +26,57 @@ You can log out by clicking ** > *Logout* in the top right. .. _3di_management_schematisations: -Schematisations -=============== +Schematisations list +==================== If you click the *Schematisations* tile in the overview, you will see a list of all :ref:`schematisations ` within your organization. This list of schematisations can be exported to an Excel file. -You can find a specific schematisation by searching its Name, Tag, or Creator using the search bar. Once you locate the desired schematisation, you can click on its name to open the detailed view. In this detailed view, you have the following options: +You can find a specific schematisation by searching its Name, Tag, or Creator using the search bar. Once you locate the desired schematisation, you can click on its name to open the detailed view. -- View all information related to the :ref:`threedimodel`. -- Verify the IDs. -- Select a different revision. -- Review the history of simulations conducted with this schematisation. -- Download the SQLite file and rasters. -- Generate or regenerate a 3Di model and track its progress. -- Delete the schematisation, its revisions, associated models (note: all revisions must be deleted first), and simulation templates. -- Explore the simulation templates connected to the schematisation. +Schematisation detail page +========================== + +The schematisation detail page consists of the following sections: + +- Schematisation +- Revision +- 3Di Model of this revision +- Predefined simulation data (if applicable) + +Schematisation +-------------- + +Describes the schematisation. In this section you can change the properties of the schematisation, such as the name, description, and tags. You can also transfer the schematisation to another organisation or delete the schematisation. + +Revision +-------- + +This section gives information on the selected revision. To view the properties of another revision of this schematisation, click *Choose other* revision. +In this section you can download the SQLite file and rasters for this revision. + +3Di Model of this revision +-------------------------- + +If a 3Di Model has been generated for this revision, this section shows the properties of the 3Di Model, such as model name, model size (nodes and line count), extent and location, + +.. _regenerate_3di_model: + +(Re-)generate 3Di Model +^^^^^^^^^^^^^^^^^^^^^^^ + +Under the heading *Re-generate*, you can see if the 3Di Model is still up to date, i.e. if it has been generated with the most recent 3Di framework version. If it says here that "The model is **not** up to date", you may want to re-generate the 3Di Model. In most cases, this will not be necessary, but if there are any problems with this 3Di Model, please re-generate the 3Di model to see if this solves the issues. + +To re-generate the 3Di model, click *Re-generate this 3Di model*. + +Simulation templates +^^^^^^^^^^^^^^^^^^^^ + +This table gives an overview of the simulation templates that are available for this 3Di model. + + +Predefined simulation data (if applicable) +------------------------------------------ + +This section shows initial (ground)water level rasters and saved states that are available for the selected 3Di model. .. _3di_management_models: diff --git a/source/f_problem_solving.rst b/source/f_problem_solving.rst index d3d3ae29..05b5b0f1 100644 --- a/source/f_problem_solving.rst +++ b/source/f_problem_solving.rst @@ -8,7 +8,7 @@ Some issues are due to the software, these will be summarised in the section Kno Errors related to input data or other user settings are usually covered by the schematisation checker. In rare cases however they might not catch a potential issue. - :ref:`model_size_limitations` -- :ref:`debug_crashing_model` +- :ref:`problem_solving_guide` - :ref:`faq` - :ref:`known_issues` @@ -50,31 +50,32 @@ Maximum raster size The maximum size of the Digital Elevation Model is 5 billion pixels. This includes NoData pixels. The other rasters will be resampled to the resolution of the DEM, so their pixel count is not relevant. -.. _debug_crashing_model: +.. _problem_solving_guide: -Debug guide crashed Generation & Simulation -------------------------------------------- +Problem solving guide +--------------------- -Crashes during model generation and simulations can often be addressed by examining certain variables. It is advisable to explore all available debugging options before submitting a ticket to the service desk. This proactive approach can help resolve issues more efficiently. If the problem persists despite following these recommendations, mentioning that you've already attempted these steps when submitting your ticket to the service desk +The 3Di computational core is very stable and crashing simulations are very uncommon. Most schematisation errors that result in a failure to generate a valid 3Di model, or in crashing simulations, will be caught by the :ref:`schematisation checker`. However, if you do run into an error or crash, there are several things you can do to resolve the issues before contacting the :ref:`servicedesk`. The service desk will always ask you to go through these steps before your issue is taken up. -Crash during model generation -^^^^^^^^^^^^^^^^^^^^^^^^ +Errors during 3Di model generation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +- Run the :ref:`schematisation checker`. Resolve any errors reported by the checker. Also look into the warnings and info messages and try to resolve those as well, unless you are convinced that the schematisation choice for which te schematisation checker gives a warning is the correct choice for your specific use case. +- Check if the 3Di Modeller Interface and the 3Di plugins are up to date. If this is not the case, :ref:`update the 3Di plugins` and run the schematisation checker again. It is recommended to :ref:`re-install the 3Di Modeller Interface` every year at the end of March. +- Check if your model is not too large, see :ref:`model_size_limitations` +- If the model generation failed while making the simulation template: Check your initial settings in your schematisation including initial (ground)water level raster. -- check if the plug-ins in your modeller interface are up to date. If this is not the case, re-run the modelchecker with the updated plug-ins. -- check if your model is within limitations: :ref:`model_size_limitations` -- If the model generation failed on making the simulation template: Check your initial settings in your schematisation including initial (ground)water level raster. +.. todo:: + Margriet gaat op een rijtje zetten welke tabellen/kolommen door de template worker worden gebruikt, zodat we dat hier kunnen toevoegen -Crash during simulation +Crashed simulations ^^^^^^^^^^^^^^^^^^^ -A few things that are often the cause of crashing simulations have been noted in the list below. Please check these if you encounter crashing simulations. +Common causes for crashing simulations are noted in the list below. Please check these if you encounter crashing simulations. -- Check if your model up to date. The model generation will always use the latest 3Di framework, but if the 3Di model was generate a long time ago, or there was a new release after the generation of your model, your 3di model can be outdated. You can easily re-generate your model when your model page on the 3di management site. +- Check if your 3Di model is up to date. The model generation will always use the latest 3Di framework, but if the 3Di model was generated a long time ago, or there was a new release after the generation of your model, your 3di Model may be outdated. Please :ref:`re-generate the 3Di model` to see if this resolves your issue. - It could be that you missed something when uploading your schematisation, when encountering a crashing simulation. You could download your schematisation and run this schematisation again to see if you missed any warnings. -If these suggestions did not solve your problem, you can try to run your simulation on the livesite. When your model does run on the livesite, it could be that something is wrong with your simulation template. Check this for any weird/wrong settings and restart your simulation. - - +If these suggestions did not solve your problem, you can try to run your simulation on the 3Di Live. When your model does run on 3Di Live, it could be that something is wrong with your simulation template. Check this for any weird/wrong settings and restart your simulation. .. _faq: diff --git a/source/f_servicedesk.rst b/source/f_servicedesk.rst index 1697897d..6fca312b 100644 --- a/source/f_servicedesk.rst +++ b/source/f_servicedesk.rst @@ -6,7 +6,7 @@ Service desk Nelen & Schuurmans provide a Service Desk function via https://nelen-schuurmans.topdesk.net/, The Nelen & Schuurmans Self Service Portal shall be available 24/7. The Service Desk gives support on all 3Di modules for 3Di customers. -Customers can reach telephonic support (Prio 1) on working days from 09:00 - 17:00 (CEST) excluding the days declared as dutch public holiday close days. +Customers can reach telephonic support (Prio 1) on working days from 09:00 - 17:00 (CEST) excluding the days declared as Dutch public holiday close days. Customers shall report incidents primarily via the Self Service Portal but may also do so via email: servicedesk@nelen-schuurmans.nl. This access should be used for, but not limited to: @@ -20,8 +20,10 @@ This access should be used for, but not limited to: All incidents relating to the 3Di software with the exception of enhancement/feature requests are recorded and followed up at no additional cost. +When reporting an issue, please provide all information that is needed for the service desk to reproduce the issue, such as schematisation ID, 3Di model ID, revision number, simulation ID, etc. + +If you have an issue with generating 3Di models or crashing simulations, please follow the :ref:`problem_solving_guide`. If the problem persists despite following the recommendations in the Problem solving guide, please mention in your service desk ticket that you have already attempted these steps. -If there is an error, please provide as much information as you can about the error and the model and revision number for which the error occurs. Priority incidents diff --git a/source/i_checking_schematisations.rst b/source/i_checking_schematisations.rst index ef220dd2..49502c6a 100644 --- a/source/i_checking_schematisations.rst +++ b/source/i_checking_schematisations.rst @@ -1,14 +1,14 @@ .. _checking_model: Checking the schematisation -=================================== +=========================== It is highly recommended to check your schematisation before uploading. It helps you detect and solve errors or warnings early on. .. _schematisationchecker: Schematisation checker -------------------------- +---------------------- The *schematisation checker* checks your 3Di schematisation (.sqlite file) for completeness and consistency between tables. With the checker you detect most database errors before uploading the schematisation to the 3Di servers for model generation. @@ -37,7 +37,7 @@ For a table of all the checks run on the schematisation, and their respective er Visualising computational grids --------------------------------- +------------------------------- 3Di builds a computational grid from schematisation data (stored in spatialite and rasters). This computational grid is stored in a "gridadmin.h5" file. You can visualize these grids in the 3Di Modeller Interface.