Skip to content

Commit

Permalink
Deploying to gh-pages from @ f316323 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ponceta committed Oct 3, 2024
1 parent 0888fe9 commit 5cd6f3c
Show file tree
Hide file tree
Showing 279 changed files with 581 additions and 847 deletions.
10 changes: 5 additions & 5 deletions _sources/admin-guide/datamodel-tool/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down Expand Up @@ -39,17 +39,17 @@ 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**:

* **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**
Expand All @@ -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.
9 changes: 4 additions & 5 deletions _sources/admin-guide/db-update-pum/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/QGEP/datamodel/releases/>`_.
The releases of the datamodel are available `here <https://github.com/QGEP/datamodel/releases/>`_.
When a new datamodel is released, a QGEP database can be updated with `PUM <https://github.com/opengisch/pum>`_.
In this documentation, the main steps and requirements are reproduced.

Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand All @@ -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

1 change: 0 additions & 1 deletion _sources/admin-guide/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ In discussion:
* Shape
* MOUSE / MikeUrban (please connect with the developer team if you are interested in this)
* other

17 changes: 8 additions & 9 deletions _sources/admin-guide/interlis-io/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/QGEP/qgepqwat2ili/blob/master/qgepqwat2ili/config.py>`_).
+ VSA-KEK 'VSA_KEK_2019_LV95', which is an extension to the SIA405 wastewater model `SIA405_ABWASSER_2015_LV95` (for more details see `config <https://github.com/QGEP/qgepqwat2ili/blob/master/qgepqwat2ili/config.py>`_).

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 <https://www.sjib.ch/wie-uebersetze-ich-eine-interlis-transferdatei-in-eine-andere-sprache/>`_ the manual translation with the tool ili2db is explained in detail.
Expand All @@ -27,7 +27,7 @@ You need java on your system.
Windows : `Java for windows download <https://javadl.oracle.com/webapps/download/AutoDL?BundleId=245058_d3c52aa6bfa54d3ca74e617f18309292>`_
MacOS : `Java for MacOS download <https://javadl.oracle.com/webapps/download/AutoDL?BundleId=245051_d3c52aa6bfa54d3ca74e617f18309292>`_
Linux : use the package manager

Python libraries
-----------------
You need `sqlalchemy` and `geoalchemy2`.
Expand All @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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 <https://vsa.ch/Mediathek/gep-datachecker-jahresgebuehr/?media_filter_two=lizenzen-software>`_

1 change: 0 additions & 1 deletion _sources/admin-guide/pgadmin/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

6 changes: 3 additions & 3 deletions _sources/admin-guide/pgadmin/usage.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SQL query
.. figure:: images/sql-query4.jpg

**Running SQL commands in pgAdmin4**



.. note::
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion _sources/features-guide/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)

1 change: 0 additions & 1 deletion _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ Indices and tables

* :ref:`genindex`
* :ref:`search`

18 changes: 9 additions & 9 deletions _sources/installation-guide/database-initialization.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
^^^^^^^^^^^^^^^^
Expand All @@ -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

Expand Down Expand Up @@ -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`.


Expand Down
4 changes: 2 additions & 2 deletions _sources/installation-guide/server.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions _sources/qgep_swmm/Change-Default-Export-Parameters.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 4 additions & 4 deletions _sources/qgep_swmm/Check-SWMM-File.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 <https://github.com/QGEP/QGEP/issues/613>`_

Catchment area connected to secondary wastewater structure
Expand All @@ -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::
Expand All @@ -85,7 +85,7 @@ Missing population densities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code::
ERROR 211: invalid number dailyPatternDWF at line 4288 of [DWF] section:
00000000WN006032 FLOW dailyPatternDWF
Expand Down
8 changes: 4 additions & 4 deletions _sources/qgep_swmm/Coefficient-Of-Friction.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ 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* <https://pdfslide.net/documents/atv-dvwk-a-110-e-55846635d4eef.html>`_
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* <https://pdfslide.net/documents/atv-dvwk-a-110-e-55846635d4eef.html>`_


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.
You can choose if you want to overwrite or not the values existing in this attribute.

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.
- ``Overwrite existing default values``: If checked the values stored in ``swmm_default_coefficient_of_friction`` will be overwrited with new values.
9 changes: 4 additions & 5 deletions _sources/qgep_swmm/Create-Input.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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``

2 changes: 1 addition & 1 deletion _sources/qgep_swmm/Extract-Results.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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``:
Expand Down
5 changes: 2 additions & 3 deletions _sources/qgep_swmm/Import-Results.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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`).


Expand All @@ -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.

Loading

0 comments on commit 5cd6f3c

Please sign in to comment.