diff --git a/.tx/config b/.tx/config index eb81cff1d..3457d8b80 100644 --- a/.tx/config +++ b/.tx/config @@ -54,4 +54,3 @@ source_file = i18n/pot/translation.pot source_lang = en file_filter = i18n//translation.po type = PO - diff --git a/conf.py b/conf.py index 6e8bbf3c9..e2ea51e50 100644 --- a/conf.py +++ b/conf.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # # QGEP documentation build configuration file, created by # sphinx-quickstart on Tue Jul 28 13:28:43 2015. @@ -12,18 +11,16 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys -import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -31,167 +28,167 @@ extensions = [] # Add any paths that contain templates here, relative to this directory. -templates_path = ['templates'] +templates_path = ["templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'QGEP' -copyright = u'2023, The QGEP Project www.teksi.ch' +project = "QGEP" +copyright = "2023, The QGEP Project www.teksi.ch" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.7' +version = "0.7" # The full version, including alpha/beta/rc tags. -release = '0.8' +release = "0.8" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ["_build"] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['themes/sphinx_rtd_theme',] +html_theme_path = [ + "themes/sphinx_rtd_theme", +] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'QGEPdoc' +htmlhelp_basename = "QGEPdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# added by mkuhn: see https://travis-ci.org/QGEP/docs/builds/78364932#L3944 -# 'babel': r'\usepackage[german,romanian,english,french]{babel}', -# The paper size ('letterpaper' or 'a4paper'). - 'papersize': 'a4paper', - - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - 'preamble': u'''\\usepackage{combelow} + # added by mkuhn: see https://travis-ci.org/QGEP/docs/builds/78364932#L3944 + # 'babel': r'\usepackage[german,romanian,english,french]{babel}', + # The paper size ('letterpaper' or 'a4paper'). + "papersize": "a4paper", + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + "preamble": """\\usepackage{combelow} \\usepackage{newunicodechar} \\newunicodechar{Ș}{\\cb{S}} @@ -203,49 +200,45 @@ \\providecommand{\\setactivedoublequote}{} % switch new babel-italian to the old behavior \\setactivedoublequote - ''' + """, } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'QGEP.tex', u'QGEP Documentation', - u'The QGEP Project/OPENGIS.ch', 'manual'), + ("index", "QGEP.tex", "QGEP Documentation", "The QGEP Project/OPENGIS.ch", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'qgep', u'QGEP Documentation', - [u'The QGEP Project/OPENGIS.ch'], 1) -] +man_pages = [("index", "qgep", "QGEP Documentation", ["The QGEP Project/OPENGIS.ch"], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -254,22 +247,28 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'QGEP', u'QGEP Documentation', - u'The QGEP Project/OPENGIS.ch', 'QGEP', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "QGEP", + "QGEP Documentation", + "The QGEP Project/OPENGIS.ch", + "QGEP", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False # Path for sphinx to find *.mo files for translation -locale_dirs = ['../i18n'] +locale_dirs = ["../i18n"] diff --git a/en/admin-guide/datamodel-tool/index.rst b/en/admin-guide/datamodel-tool/index.rst index eec2125cb..f74ae2f62 100644 --- a/en/admin-guide/datamodel-tool/index.rst +++ b/en/admin-guide/datamodel-tool/index.rst @@ -11,7 +11,7 @@ For advanced cases, it is also possible to `upgrade your database manually <../d Setup ----- -The data-model tool is hidden by default. To make it visible, you must first enable ``Admin mode`` +The data-model tool is hidden by default. To make it visible, you must first enable ``Admin mode`` in the plugin settings : * Go to ``Plugin > QGEP > Settings`` @@ -39,7 +39,7 @@ The main dialog looks like this. * **Version**: the version to retrieve the files from. Unless ``developer mode`` is enabled in the QGEP settings, only the latest stable version is available. Selecting anything different from the latest stable version should only ever be used on a testing database, as it could upgrade the database to an inconsistent state. * **Dependencies**: - + * **Python requirements**: If there are missing python requirements, click on the **install button** to try to install them automatically. Note that this will not work on all systems. If it fails, you can try to start QGIS with administrator privileges, or `install the dependencies manually <../db-update-pum/index.html#requirements>`_. * **Postgres service configurations**: @@ -47,9 +47,9 @@ The main dialog looks like this. * **File location**: shows the location of the ``pg_service.conf`` file being used * **PG Config**: allows to select the postgres service configuration of the database on which you want to operate. **WARNING**: by default, the first entry is selected, which may not match the database used by your currently open QGEP project. - + * **``+`` button**: opens an utility to add or edit entries from your ``pg_service.conf`` file directly. - + Refer to the `installation guide <../../installation-guide/workstation.html>`_ to know more about the ``pg_service.conf`` file. * **Datamodel** @@ -68,7 +68,7 @@ The main dialog looks like this. Troubleshooting ^^^^^^^^^^^^^^^ -In case you encounter issues or errors when using the datamodel tool, make sure to look at the +In case you encounter issues or errors when using the datamodel tool, make sure to look at the QGEP tab in the logs, as it may contain useful information (including errors returned by underlying tools). Make sure to include this information if submitting a bug report or asking for support. diff --git a/en/admin-guide/db-update-pum/index.rst b/en/admin-guide/db-update-pum/index.rst index 5286988dd..92923a669 100644 --- a/en/admin-guide/db-update-pum/index.rst +++ b/en/admin-guide/db-update-pum/index.rst @@ -5,7 +5,7 @@ This page explains how to update your datamodel manually. Alternatively, the `da <../datamodel-tool/index.html>`_ offers a graphical interface that automates these steps and is usually easier to use. -The releases of the datamodel are available `here `_. +The releases of the datamodel are available `here `_. When a new datamodel is released, a QGEP database can be updated with `PUM `_. In this documentation, the main steps and requirements are reproduced. @@ -81,11 +81,11 @@ Download and install current database release ``psql -h host -p port -U postgres -c 'CREATE DATABASE qgep_comp;'`` -* Install current datamodel release. +* Install current datamodel release. ``./scripts/db_setup.sh -f -r -p qgep_comp`` Launched from the ``datamodel`` folder. -Create empty database +Create empty database ^^^^^^^^^^^^^^^^^^^^^^ * Create test database. It is used to test the update processus. @@ -95,7 +95,7 @@ Launch update ^^^^^^^^^^^^^^ The following command must be launched form the ``datamodel`` folder. -``pum test-and-upgrade -pp qgep_prod -pt qgep_test -pc qgep_comp -t qgep_sys.pum_info -f dump.dump -d delta/ -i constraints views indexes --exclude-schema public --exclude-schema qgep_migration -v int SRID 2056 -x``. +``pum test-and-upgrade -pp qgep_prod -pt qgep_test -pc qgep_comp -t qgep_sys.pum_info -f dump.dump -d delta/ -i constraints views indexes --exclude-schema public --exclude-schema qgep_migration -v int SRID 2056 -x``. * ``-pp`` Production database * ``-pt`` Test database @@ -107,4 +107,3 @@ The following command must be launched form the ``datamodel`` folder. * ``-v`` Parameters of the delta scripts * ``-x`` Ignore restore errors (materialized views can generate ``pg_restore`` errors * ``--exclude-field-pattern 'usr_%'`` if custom attributes were added - diff --git a/en/admin-guide/index.rst b/en/admin-guide/index.rst index 63a1697f3..762004c55 100644 --- a/en/admin-guide/index.rst +++ b/en/admin-guide/index.rst @@ -19,4 +19,3 @@ In discussion: * Shape * MOUSE / MikeUrban (please connect with the developer team if you are interested in this) * other - diff --git a/en/admin-guide/interlis-io/index.rst b/en/admin-guide/interlis-io/index.rst index fadf17e40..77f5a07ee 100644 --- a/en/admin-guide/interlis-io/index.rst +++ b/en/admin-guide/interlis-io/index.rst @@ -11,7 +11,7 @@ The QGEP plugin includes an INTERLIS import/export feature. It is currently capable of importing and exporting to the following models: + VSA-DSS 'DSS_2015_LV95' + SIA405 Abwasser 'SIA405_ABWASSER_2015_LV95` - + VSA-KEK 'VSA_KEK_2019_LV95', which is an extension to the SIA405 wastewater model `SIA405_ABWASSER_2015_LV95` (for more details see `config `_). + + VSA-KEK 'VSA_KEK_2019_LV95', which is an extension to the SIA405 wastewater model `SIA405_ABWASSER_2015_LV95` (for more details see `config `_). Note that currently, exports are possible in German only. Translated exports are on the roadmap, let us know if you are interested in this feature. In `this blog post `_ the manual translation with the tool ili2db is explained in detail. @@ -27,7 +27,7 @@ You need java on your system. Windows : `Java for windows download `_ MacOS : `Java for MacOS download `_ Linux : use the package manager - + Python libraries ----------------- You need `sqlalchemy` and `geoalchemy2`. @@ -41,15 +41,15 @@ and type:: >>> pip3 install "sqlalchemy~=1.3.22" "geoalchemy2>=0.9.0" If the command fails, try:: - + >>> pip3 install --upgrade pip .. note:: If pip cannot be found, make sure you’ve installed the python3-pip package using the OSGeo4W network installer (if you’ve installed the standalone version of QGIS, it should be included). -If this command still fails, try:: +If this command still fails, try:: >>> pip3 install --target=c:\somewhere\other\than\the\default --upgrade pip - + where ``c:\somewhere\other\than\the\default`` is the path to your current pip package The same `--target` flag can be added to install `sqlalchemy` and `geoalchemy2` in another location. @@ -71,7 +71,7 @@ Usage (GUI) Enable admin mode ------------------------------------------------- -In the `plugin>QGEP>settings` dialog, under the `Developer options` tab, ensure `Admin mode` is enabled. Restart QGIS. +In the `plugin>QGEP>settings` dialog, under the `Developer options` tab, ensure `Admin mode` is enabled. Restart QGIS. .. figure:: images/settings_dialog.png @@ -100,7 +100,7 @@ The export tool is capable of exporting label positions for different scales. Yo You can also change the angle for horizontal text in INTERLIS if your target system has another convention than INTERLIS. -Then, confirm the dialog and choose where to save the `.xtf` file. +Then, confirm the dialog and choose where to save the `.xtf` file. .. note:: The export model name will be added to your filename that you choose. export.xtf will become export_DSS_2015_LV95.xtf @@ -142,7 +142,7 @@ Exports include a validation step using `ilivalidator`, which will inform you wh Import ------------------------------------------------- -To import `xtf`files, click on the `import` button and navigate to the `.xtf` file. +To import `xtf`files, click on the `import` button and navigate to the `.xtf` file. .. note:: Note that windows file pathes with empty strings in the directory path or filename are not supported at the moment. @@ -183,4 +183,3 @@ Quality control of an export file with VSA online checker (Fachprüfung mit VSA `Information about access and licensing you can get here `_ - diff --git a/en/admin-guide/pgadmin/install.rst b/en/admin-guide/pgadmin/install.rst index 7c5b6e3ef..42d48ded0 100644 --- a/en/admin-guide/pgadmin/install.rst +++ b/en/admin-guide/pgadmin/install.rst @@ -34,4 +34,3 @@ Suse based distros sudo (admin) privileges. On certain systems it may be required to use the command ``su`` to become the *root* user and then issue the above command without the ``sudo`` prefix. - diff --git a/en/admin-guide/pgadmin/usage.rst b/en/admin-guide/pgadmin/usage.rst index 93e7849db..5163e7e4a 100644 --- a/en/admin-guide/pgadmin/usage.rst +++ b/en/admin-guide/pgadmin/usage.rst @@ -9,7 +9,7 @@ SQL query .. figure:: images/sql-query4.jpg **Running SQL commands in pgAdmin4** - + .. note:: @@ -27,9 +27,9 @@ Database dump * Open pgAdmin4 and connect to the database * Right click the Schema that you want to backup (in the tree structure below "Schemas") * Enter the filename where the dump should be stored - + .. figure:: images/database-dump-general4.jpg - + * Click the option-tab and check the following options .. figure:: images/database-dump-options4.jpg diff --git a/en/features-guide/index.rst b/en/features-guide/index.rst index 4ea29aebf..d96c5c7d2 100644 --- a/en/features-guide/index.rst +++ b/en/features-guide/index.rst @@ -70,4 +70,3 @@ More to come * Automatic integration of pipe inspection according to Wincan VX and VSA-DSS KEK format * GEP mesures * Log Cards (log_card, bio_ecol_assessment and catchment_area_totals) - diff --git a/en/index.rst b/en/index.rst index 412133f20..7389112b1 100644 --- a/en/index.rst +++ b/en/index.rst @@ -34,4 +34,3 @@ Indices and tables * :ref:`genindex` * :ref:`search` - diff --git a/en/installation-guide/database-initialization.rst b/en/installation-guide/database-initialization.rst index 24dea5d35..d08c6d7d3 100644 --- a/en/installation-guide/database-initialization.rst +++ b/en/installation-guide/database-initialization.rst @@ -28,7 +28,7 @@ Restore the latest data model that also includes demo data: * Download demo data * https://github.com/QGEP/datamodel/releases/latest * download `qgep_vx.y.z_structure_and_demo_data.backup` - + Back in pgAdmin : * Right click the `qgep_prod` database @@ -41,16 +41,16 @@ Back in pgAdmin : .. figure:: images/demodata-restore.jpg * Click the `Restore Options` Tab and check these options - + .. figure:: images/demodata-restore_options.jpg * Click `Restore` - + * Check whether in Message window `Restoring backup on the server` is successfully completed. - + .. note:: - + If the Restore is failed and the detail reads something like "pg_restore: [archiver] unsupported version (1.13) in file header" or in German "pg_restore: [Archivierer] nicht unterstützte Version (1.13) im Dateikopf" try updating your PostgreSQL, see https://stackoverflow.com/questions/49064209/getting-archiver-unsupported-version-1-13-in-file-header-when-running-pg-r * Close the Restoring-Window @@ -68,7 +68,7 @@ Create minimal roles and access .. note:: The QGEP roles are defined in the https://github.com/QGEP/datamodel/blob/master/12_0_roles.sql (per cluster) and https://github.com/QGEP/datamodel/blob/master/12_1_roles.sql (per database) files. It is recommended to use these when using QGEP in a production environment. -Copy paste and run the two .sql one after the other in the query editor of pgAdmin4 (Tools > Query Tool). +Copy paste and run the two .sql one after the other in the query editor of pgAdmin4 (Tools > Query Tool). Empty data model ^^^^^^^^^^^^^^^^ @@ -81,8 +81,8 @@ You also have the option to restore the latest empty data model (no demo data). .. note:: If you run the sql in a :ref:`SQL-query` Window, you will get an error. You have to use a BAT-File. - -* Use a BAT-File like that, to create the database, the extensions and the schemas with valuelist (replace x.y.z with your version):: + +* Use a BAT-File like that, to create the database, the extensions and the schemas with valuelist (replace x.y.z with your version):: @echo off @@ -129,7 +129,7 @@ You also have the option to restore the latest empty data model (no demo data). .. note:: You are free to choose any database name. - + * Update privileges for the qgep_od, qgep_sys, qgep_vl, qgep_network, qgep_import, qgep_swmm schema as described in the chapter `Create minimal roles and access`. diff --git a/en/installation-guide/server.rst b/en/installation-guide/server.rst index e63f8b4f0..b5d639d86 100644 --- a/en/installation-guide/server.rst +++ b/en/installation-guide/server.rst @@ -18,11 +18,11 @@ Server installation * Install PostGIS (>=2.4) * E. g. by using the (Application) Stack Builder shipped with the EnterpriseDB version of posgreSQL on Windows and macOS - + .. note:: The following instructions are **optional**: - + In a single desktop environment (no network database server) you can setup your database to trust local connections. diff --git a/en/qgep_swmm/Change-Default-Export-Parameters.rst b/en/qgep_swmm/Change-Default-Export-Parameters.rst index a3922e674..1af448773 100644 --- a/en/qgep_swmm/Change-Default-Export-Parameters.rst +++ b/en/qgep_swmm/Change-Default-Export-Parameters.rst @@ -5,9 +5,9 @@ Change default export parameters -------------------------------- As mentionned earlier, most of the simulation parameters are copied from the template ``.inp`` file. -Remaining default parameters are currently hard coded in the views within the database ``qgep_swmm`` schema. -The defaults parameters can be edited directly in the view (with PgAdmin). +Remaining default parameters are currently hard coded in the views within the database ``qgep_swmm`` schema. +The defaults parameters can be edited directly in the view (with PgAdmin). -.. note:: +.. note:: The default parameters modified in the views and modified views in general will be overwritten during a datamodel update. diff --git a/en/qgep_swmm/Check-SWMM-File.rst b/en/qgep_swmm/Check-SWMM-File.rst index bb0c5f45a..8905b4ec7 100644 --- a/en/qgep_swmm/Check-SWMM-File.rst +++ b/en/qgep_swmm/Check-SWMM-File.rst @@ -11,7 +11,7 @@ To fix an error you can search in the corresponding QGEP layers in the QGIS proj - vw_wastewater_node for undefined nodes - catchment_area for subcatchment errors -- compare if the number of exported nodes (in vw_junctions) are what you expect it to be. +- compare if the number of exported nodes (in vw_junctions) are what you expect it to be. - Check if the function (manhole / special_structure) of wastewater_structure are all filled in - etc. @@ -34,7 +34,7 @@ The catchment area is linked to node which is not exported or a reach cannot be and therefore not export in the vw_junctions. Check your data manually before the export if wastwater_structure.status is not empty. Check whether wastwater_structure._function_hierachic is filled in on Primary network nodes (PAA nodes). - + `For more details see related Github issue `_ Catchment area connected to secondary wastewater structure @@ -59,7 +59,7 @@ Missing discharge coefficients ch19ar68CA008855_ww_current raingage@ch19ar68CA008855 CHamtKnv00001992 0.0276 19.4322613668305 -The subcatchement discharge coefficients are not filled in. +The subcatchement discharge coefficients are not filled in. You can find them using sql: .. code:: @@ -85,7 +85,7 @@ Missing population densities ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: - + ERROR 211: invalid number dailyPatternDWF at line 4288 of [DWF] section: 00000000WN006032 FLOW dailyPatternDWF diff --git a/en/qgep_swmm/Coefficient-Of-Friction.rst b/en/qgep_swmm/Coefficient-Of-Friction.rst index 4587ee6cc..42a69407e 100644 --- a/en/qgep_swmm/Coefficient-Of-Friction.rst +++ b/en/qgep_swmm/Coefficient-Of-Friction.rst @@ -14,13 +14,13 @@ Coefficient of friction .. note:: - The formula to convert from Strickler to Coolebrook is documented in `*ATV-DVWK STANDARD ATV-DVWK-A 110E, Hydraulic Dimensioning and Performance Verification of Sewers and Drains September 2001* `_ - + The formula to convert from Strickler to Coolebrook is documented in `*ATV-DVWK STANDARD ATV-DVWK-A 110E, Hydraulic Dimensioning and Performance Verification of Sewers and Drains September 2001* `_ + Populate default coefficient of friction ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The table ``qgep_swmm.reach_coefficient_of_friction`` contains default coefficient of Strickler for the reach materials. +The table ``qgep_swmm.reach_coefficient_of_friction`` contains default coefficient of Strickler for the reach materials. The file ``../project/qml/reach_coefficient_of_friction.qml`` is the layer definition, that you can import in your QGIS project. If the default values don't match your needs you can edit them. The function ``SWMM Set default coefficient of friction`` will put in ``qgep_od.reach.swmm_default_coefficient_of_friction`` these default values. @@ -28,4 +28,4 @@ You can choose if you want to overwrite or not the values existing in this attri Launch ``SWMM Set default coefficient of friction``: -- ``Overwrite existing default values``: If checked the values stored in ``swmm_default_coefficient_of_friction`` will be overwrited with new values. \ No newline at end of file +- ``Overwrite existing default values``: If checked the values stored in ``swmm_default_coefficient_of_friction`` will be overwrited with new values. diff --git a/en/qgep_swmm/Create-Input.rst b/en/qgep_swmm/Create-Input.rst index c4ec9bf35..13944c1bc 100644 --- a/en/qgep_swmm/Create-Input.rst +++ b/en/qgep_swmm/Create-Input.rst @@ -3,7 +3,7 @@ SWMM Create Input ----------------- -- By default, the plugin extracts the entire primary wastewater structures. If you check *Export only selected network*, then both the selected primary and secondary network will be exported. +- By default, the plugin extracts the entire primary wastewater structures. If you check *Export only selected network*, then both the selected primary and secondary network will be exported. - The ``.inp`` file is the input file format for SWMM. It contains the wastewater network AND simulation parameters. The network can be extracted from the QGEP data, but the simulation parameters must be set according to your study. @@ -20,18 +20,17 @@ Launch ``SWMM Create Input``: - ``Template INP file``: a ``.inp`` from which simulation parameters will be copied - ``Destination INP file``: the ``.inp`` generated from QGEP data - ``Export only selected network``: Export primary and secondary selected network - + Selection --------- -Usually you will select a subnetwork to be exported with the QGEP button ``Upstream`` and then ``Select current path``. +Usually you will select a subnetwork to be exported with the QGEP button ``Upstream`` and then ``Select current path``. If you want to remove from this selection secondary structures: - Open ``Selection by expression`` on the layer ``vw_qgep_reach`` - Expression: ``"ch_function_hierarchic" in (5066, 5068, 5069, 5070, 5064, 5071, 5062, 5072, 5074)`` - Choose: ``filter current selection`` - + - Open ``Selection by expression`` on the layer ``vw_qgep_wastewater_structure`` - Expression: ``"_channel_function_hierarchic" in (5066, 5068, 5069, 5070, 5064, 5071, 5062, 5072, 5074)`` - Choose: ``filter current selection`` - \ No newline at end of file diff --git a/en/qgep_swmm/Extract-Results.rst b/en/qgep_swmm/Extract-Results.rst index 4547f5e8c..6ff363f41 100644 --- a/en/qgep_swmm/Extract-Results.rst +++ b/en/qgep_swmm/Extract-Results.rst @@ -3,7 +3,7 @@ SWMM Extract Results -------------------- -If you don't want to store the results in QGEP, this function generates two QGIS tables from a report file. +If you don't want to store the results in QGEP, this function generates two QGIS tables from a report file. You can map the values with the geometries (see: :ref:`mapping-not-imported`). Launch ``SWMM Extract results``: diff --git a/en/qgep_swmm/Import-Results.rst b/en/qgep_swmm/Import-Results.rst index 1423f2e31..e01c2a619 100644 --- a/en/qgep_swmm/Import-Results.rst +++ b/en/qgep_swmm/Import-Results.rst @@ -7,7 +7,7 @@ Measurement tables ^^^^^^^^^^^^^^^^^^ If you want to store the results in QGEP and use the dedicated view for the mapping then use SWMM Import Results. -It parses the report file of SWMM. +It parses the report file of SWMM. The results are imported in the measurements tables in the ``qgep_od`` schema: - ``measuring_point``: there is one *measuring point* for each *wastewater structure* and simulation, @@ -34,7 +34,7 @@ The results are imported in the measurements tables in the ``qgep_od`` schema: Measurement result - + and they populate a view dedicated for the mapping (see :ref:`mapping-imported`). @@ -53,4 +53,3 @@ Launch ``SWMM Import results``: .. warning:: Attention, a report file created from the SWMM GUI don't contain the full time series but only the summary. - diff --git a/en/qgep_swmm/Mapping.rst b/en/qgep_swmm/Mapping.rst index ca5d3efaa..95b02a860 100644 --- a/en/qgep_swmm/Mapping.rst +++ b/en/qgep_swmm/Mapping.rst @@ -57,4 +57,4 @@ This manipulation only works with complete times series. Namely, you need to imp .. figure:: images/DataPlotly_parameters.jpg -.. figure:: images/DataPlotly_plot.png \ No newline at end of file +.. figure:: images/DataPlotly_plot.png diff --git a/en/qgep_swmm/Prepare-Data.rst b/en/qgep_swmm/Prepare-Data.rst index 7a5d59dad..9779f7165 100644 --- a/en/qgep_swmm/Prepare-Data.rst +++ b/en/qgep_swmm/Prepare-Data.rst @@ -8,4 +8,4 @@ Prepare Data .. include:: QGEP-SWMM-data-requirements.rst -.. include:: Coefficient-Of-Friction.rst \ No newline at end of file +.. include:: Coefficient-Of-Friction.rst diff --git a/en/qgep_swmm/QGEP-SWMM-Correspondances.rst b/en/qgep_swmm/QGEP-SWMM-Correspondances.rst index da7f6adde..3f76a57e1 100644 --- a/en/qgep_swmm/QGEP-SWMM-Correspondances.rst +++ b/en/qgep_swmm/QGEP-SWMM-Correspondances.rst @@ -12,7 +12,7 @@ No correspondance in QGEP. This parameter must be set by the user in the templat - Copied from the template input file if exists. -Options: +Options: ^^^^^^^^ No correspondance in QGEP. This parameter must be set by the user in the template ``.inp`` file or before running the simulation. @@ -29,7 +29,7 @@ Hydrology: ^^^^^^^^^^ **Rain Gauges [Gages in SWMM]:** -QGEP_SWMM creates one raingage for each subcatchment. +QGEP_SWMM creates one raingage for each subcatchment. By default: @@ -39,7 +39,7 @@ By default: - Other parameters have default SWMM values. If you want to use another Format or Interval, you have to adapt the view. See ``vw_swmm_raingages.sql`` for details. - + **Aquifers:** QGEP_SWMM creates an aquifer for each QGEP ``aquifiers``. @@ -69,7 +69,7 @@ By default: - are set to 0 for rain water subcatchments - are set to ``waste_water_production[_current,_planned]`` if set - else it computed from the subcatchement area and ``population_density[_current,_planned]`` - + - Other parameters have default SWMM values The subcatchment can be linked to an aquifer via the groundwater attribute. @@ -127,7 +127,7 @@ See ``vw_swmm_outfalls.sql`` for details. - Roughness is created from ``coefficient_of_friction``, ``wall_roughness`` or ``swmm_default_coefficient_of_friction`` (see: :ref:`Coefficient-Of-Friction`) - QGEP profile type are matched to SWMM profile type, dimensions are computed from ``reach.clear_height`` and ``pipe_profile.height_width_ratio`` - Custom pipe profile described by a curve are currently not exported - + - See ``vw_swmm_conduits.sql`` and ``vw_swmm_xsections.sql`` for details. **Pumps** @@ -138,7 +138,7 @@ See ``vw_swmm_outfalls.sql`` for details. **Orifices** -No correspondance in QGEP. Orifices are not created from QGEP objects. An empty table is created +No correspondance in QGEP. Orifices are not created from QGEP objects. An empty table is created - See ``vw_swmm_orifices.sql`` for details. @@ -173,7 +173,7 @@ Quality - QGEP_SWMM creates a SWMM land use kind for each QGEP planning zone kind. -- See ``vw_swmm_landuses.sql`` +- See ``vw_swmm_landuses.sql`` **Pollutants** @@ -203,4 +203,4 @@ Labels ^^^^^^ No correspondance in QGEP. This parameter must be set by the user in the template ``.inp`` file or before running the simulation. -- Copied from the template input file if exists. \ No newline at end of file +- Copied from the template input file if exists. diff --git a/en/qgep_swmm/QGEP-SWMM-data-requirements.rst b/en/qgep_swmm/QGEP-SWMM-data-requirements.rst index 3fcb8bf93..de22d036f 100644 --- a/en/qgep_swmm/QGEP-SWMM-data-requirements.rst +++ b/en/qgep_swmm/QGEP-SWMM-data-requirements.rst @@ -43,6 +43,6 @@ XSECTIONS .. csv-table:: XSECTIONS :header: "SWMM attribute", "Description", "QGEP equivalent" :widths: 30, 50, 30 - + "Shape", "geometric properties of the conduit's cross section e.g. CIRCULAR.", "pipe_profile.profile_type" "Geom1", "Maximum height of conduit", "reach.clear_height/1000 [m] to [mm]" diff --git a/en/qgep_swmm/QGEP-SWMM-installation.rst b/en/qgep_swmm/QGEP-SWMM-installation.rst index a8fb56916..ee371bb3d 100644 --- a/en/qgep_swmm/QGEP-SWMM-installation.rst +++ b/en/qgep_swmm/QGEP-SWMM-installation.rst @@ -11,13 +11,3 @@ SWMM Installation QGIS configuration ------------------ - In QGIS, check that the path recorded in ``Preferences > Processing > Processing providers > QGEP > SWMM executable`` matches the path of the swmm executable (by default: ``C:/Program Files (x86)/EPA SWMM 5.1.013/swmm5.exe``) - - - - - - - - - - diff --git a/en/qgep_swmm/QGEP-SWMM-workflow.rst b/en/qgep_swmm/QGEP-SWMM-workflow.rst index d8a349349..5756c94d4 100644 --- a/en/qgep_swmm/QGEP-SWMM-workflow.rst +++ b/en/qgep_swmm/QGEP-SWMM-workflow.rst @@ -12,7 +12,7 @@ Each step of the workflow is explained in details in next chapters. Prepare and check the data ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - + - The function ``SWMM Set default coefficient of friction`` can be used to fill automatically default reach friction. Generate a SWMM Export @@ -22,21 +22,21 @@ Run ``SWMM Create Input``. It: - reads simulation parameters from a template ``.inp`` file, - reads data from the QGEP views (schema ``qgep_swmm``), -- generates an input file for SWMM (``.inp``). +- generates an input file for SWMM (``.inp``). Check the Export ^^^^^^^^^^^^^^^^ -Check generated ``.inp`` file. +Check generated ``.inp`` file. -Its likely that the ``.inp`` file generated in the previous step contains errors or needs some parameters to be tuned. -We recommend to first open the ``.inp`` file with the SWMM Graphical User Interface (GUI). -Error summarized at the SWMM startup might highlight error in QGEP. Other errors can be solved directly in SWMM. +Its likely that the ``.inp`` file generated in the previous step contains errors or needs some parameters to be tuned. +We recommend to first open the ``.inp`` file with the SWMM Graphical User Interface (GUI). +Error summarized at the SWMM startup might highlight error in QGEP. Other errors can be solved directly in SWMM. If you need to tune the simulation parameters, you have to edit the ``.inp`` file with SWMM GUI. Run the simulation ^^^^^^^^^^^^^^^^^^ -Run ``SWMM Execute``, it launches SWMM. Run it on a tested ``.inp`` file. +Run ``SWMM Execute``, it launches SWMM. Run it on a tested ``.inp`` file. It generates a report file ``.rpt`` which contains the summary and the full time series. Errors can also occur during the running time. @@ -76,10 +76,3 @@ Usually, a GEP analysis has at least three steps: **Run variants (network is modified)** New links and new nodes are created directly in SWMM GUI - - - - - - - diff --git a/en/qgep_swmm/Run-SWMM-Simulation.rst b/en/qgep_swmm/Run-SWMM-Simulation.rst index 528578d75..a844e65e0 100644 --- a/en/qgep_swmm/Run-SWMM-Simulation.rst +++ b/en/qgep_swmm/Run-SWMM-Simulation.rst @@ -8,11 +8,11 @@ Run a simulation from SWMM interface You can open the ``.inp`` file with SWMM and run the simulation from the interface. -Run a simulation with command line +Run a simulation with command line ---------------------------------- .. code:: - + {EXEPATH}\swmm5.exe {INPUTPATH}\{INPUTFILENAME}.inp {OUTPUTPATH}\{REPORTFILENAME}.rpt {OUTPUTPATH}\{OUTPUTFILENAME}.out @@ -31,4 +31,4 @@ Common running errors --------------------- The list of errors can be found `here `_ -- ``ERROR 211: invalid number -XXX at line XXX of [JUNC] section:``: A negative number is provided for the depth. Change the value in QGEP or in the ``.inp`` file. \ No newline at end of file +- ``ERROR 211: invalid number -XXX at line XXX of [JUNC] section:``: A negative number is provided for the depth. Change the value in QGEP or in the ``.inp`` file. diff --git a/en/qgep_swmm/SWMM.rst b/en/qgep_swmm/SWMM.rst index 0e32bed6d..b81a96ff2 100644 --- a/en/qgep_swmm/SWMM.rst +++ b/en/qgep_swmm/SWMM.rst @@ -1,11 +1,11 @@ .. _SWMM: -Storm Water Management Model (SWMM) +Storm Water Management Model (SWMM) =================================== **Helps predict runoff quantity and quality from drainage systems** -`EPA's Storm Water Management Model (SWMM) `_ is used throughout the world for planning, analysis, and design related to stormwater runoff, combined and sanitary sewers, and other drainage systems. +`EPA's Storm Water Management Model (SWMM) `_ is used throughout the world for planning, analysis, and design related to stormwater runoff, combined and sanitary sewers, and other drainage systems. It can be used to evaluate gray infrastructure stormwater control strategies, such as pipes and storm drains, and is a useful tool for creating cost-effective green/gray hybrid stormwater control solutions. SWMM was developed to help support local, state, and national stormwater management objectives to reduce runoff through infiltration and retention, and help to reduce discharges that cause impairment of waterbodies. diff --git a/en/qgep_swmm/index.rst b/en/qgep_swmm/index.rst index 5c3e40015..cef3cfcc1 100644 --- a/en/qgep_swmm/index.rst +++ b/en/qgep_swmm/index.rst @@ -17,4 +17,4 @@ QGEP plugin is able to export a SWMM file (``.inp``) and import SWMM results. Run-SWMM-Simulation Process-Results Mapping - Developpers-Advanced-Users \ No newline at end of file + Developpers-Advanced-Users diff --git a/en/user-guide/How-To/index.rst b/en/user-guide/How-To/index.rst index bec275652..3b48c59d9 100644 --- a/en/user-guide/How-To/index.rst +++ b/en/user-guide/How-To/index.rst @@ -6,7 +6,7 @@ This represents a guide on different themes about configuring in QGEP. Manual Label-positioning for different scales --------------------------------------------- -QGIS label definition can handle different labels for different scales. This works very well if you work on the screen. +QGIS label definition can handle different labels for different scales. This works very well if you work on the screen. If you have to print plans with labels or if you have to export labels for data exchange (e.g. exchange with RegioGIS-platform), it will often be necessary to determine the label positions manually. If a label is positioned manually in QGIS, this fixed position applies to every scale. And that's not always a good result. @@ -14,7 +14,7 @@ Solution * Extend the Auxiliary Storage File with new fields for different labelpositions -* Use Rule-based labeling, then you can define different labelpositions for every rule +* Use Rule-based labeling, then you can define different labelpositions for every rule In the example below, we want to label the wastewater-structures with a detailed label for network_plan (1:500) and for overviewmap (1:2000). In the Auxiliary Storage we use the standard fields PositionX and PositionY for the network_plan labels. For the overviewmap labels we add two new fields. @@ -22,7 +22,7 @@ We name this fields posx2000 and posy2000. .. figure:: images/man_labeling_newfields.jpg -Define now rule-based labeling with two rules. In the example the first rule is called WP-Labels (WP = Werkplan = network_plan). +Define now rule-based labeling with two rules. In the example the first rule is called WP-Labels (WP = Werkplan = network_plan). You have not the change something in the placement, because this rule uses the standard positioning-fields. .. figure:: images/man_labeling_rules.jpg @@ -37,7 +37,7 @@ Click on Coordinate X menutool and choose in the field type-menu the auxiliary_s .. attention:: Do not use the **Edit...** menu for defining the coordinate-field. If you use a formula or choose the field via the Edit... menu, QGIS will overwrite the definition everytime you do a manual positioning. -Now you can move or fix your labels for every rule with different positions with the QGIS **Moves a Label or Diagram**-Tool. +Now you can move or fix your labels for every rule with different positions with the QGIS **Moves a Label or Diagram**-Tool. .. figure:: images/man_labeling_labeltools.jpg @@ -83,7 +83,7 @@ How to run symbology functions manually Sometimes the labels such as bottom, cover or entry/exit levels are not correctly displayed, even if the corresponding attribut is filled in. This happens for example when you import data by INTERLIS Import or another way. May be you also decativated the triggers to speed up the import process. * Activate / Deactivate symbology triggers:: - + SELECT qgep_sys.create_symbology_triggers() SELECT qgep_sys.drop_symbology_triggers() @@ -151,7 +151,7 @@ Hydraulic modeling of an overflow (prank weir / leapingweir / pump) Action: -In the case of weirs, a second sewage junction has to be created in the wastewater structure. +In the case of weirs, a second sewage junction has to be created in the wastewater structure. A second outlet has already been created (green = discharged combined wastewater) and has not yet been linked to any wastewater node in the overflow structure. 1. Select the wastewater structure with the i-button @@ -219,5 +219,5 @@ The Feature Attributes window for the overflow characteristic appears: Further informations -------------------- -Further Q & A's you can find in the +Further Q & A's you can find in the `QGEP Discussion section `_ diff --git a/en/user-guide/layerexplanations/layerexplanation.rst b/en/user-guide/layerexplanations/layerexplanation.rst index c6428678f..b774f0095 100644 --- a/en/user-guide/layerexplanations/layerexplanation.rst +++ b/en/user-guide/layerexplanations/layerexplanation.rst @@ -72,7 +72,7 @@ If you want to export data to the VSA-DSS 2015 model, you have to manually add t .. figure:: images/interlis_export_class_organisation_subclass_checkjpg.jpg Alternative: You can use vw_organisation instead of od_organisation. vw_organisation has the subclasses integrated and must be loaded manually to the project. - + Maintenance events ``qgep_od.vw_qgep_maintenance`` -------------------------------------------------- diff --git a/en/vm/about.rst b/en/vm/about.rst index 722c3d4a0..91945f2c9 100644 --- a/en/vm/about.rst +++ b/en/vm/about.rst @@ -7,7 +7,7 @@ working QGEP installation with a demo dataset. The VM also has a working demo of The VM is based on Debian Testing with Cinnamon Desktop. Debian Testing was chosen in order to have GDAL 2.x and also benefit from latest linux kernel so that latest hardware -won't be a problem for the case where the VM is used outside virtualization (e.g use the virtual disk as basis to create +won't be a problem for the case where the VM is used outside virtualization (e.g use the virtual disk as basis to create a non-virtualized usb-stick to be used for demo purposes). Installed software: diff --git a/en/vm/index.rst b/en/vm/index.rst index 775f63430..ee0165146 100644 --- a/en/vm/index.rst +++ b/en/vm/index.rst @@ -8,11 +8,9 @@ Demo Virtual Machine This is currently not maintained anymore: * please use the data-model tool instead -> see Admin Guide to setup an empty QGEP project * or follow this process to restore the demodata https://qgep.github.io/docs/installation-guide/database-initialization.html#restore-demo-datamodel - + This represents a guide on how to download and install a virtual machine (VM) that has a working QGEP installation with a preinstalled demo dataset. .. toctree:: :maxdepth: 2 - - diff --git a/en/wincan2qgep/match-channels.rst b/en/wincan2qgep/match-channels.rst index a09b5784c..63bdaa8e2 100644 --- a/en/wincan2qgep/match-channels.rst +++ b/en/wincan2qgep/match-channels.rst @@ -34,11 +34,3 @@ Skipping channels or observations If you want to skip some of the inspected channels, they simply need to be unchecked in the channel table and similarly for observations. .. figure:: images/skip-data.png - - - - - - - - diff --git a/en/wincan2qgep/open-inspection.rst b/en/wincan2qgep/open-inspection.rst index 7f9edc52e..7d76d334b 100644 --- a/en/wincan2qgep/open-inspection.rst +++ b/en/wincan2qgep/open-inspection.rst @@ -9,5 +9,3 @@ and select the XML file generally located in ``XML > Project.xml``. You first have to specify the report document location by setting it in the PDF field. This will allow linking it in the feature forms. Channels are listed in red in the main table since they have to be matched with the QGEP data before being imported. - - diff --git a/en/wincan2qgep/viewing-data-qgep.rst b/en/wincan2qgep/viewing-data-qgep.rst index 183159e9c..1122d82ae 100644 --- a/en/wincan2qgep/viewing-data-qgep.rst +++ b/en/wincan2qgep/viewing-data-qgep.rst @@ -6,4 +6,3 @@ The maintenance events, inspections and observations can be seen in the channel .. figure:: images/viewing-observations.png .. figure:: images/viewing-damages.png -