Skip to content

Commit 70cb0b9

Browse files
committed
This reverts commit f629c09.
1 parent f629c09 commit 70cb0b9

File tree

3 files changed

+5
-82
lines changed

3 files changed

+5
-82
lines changed

user_guide/docs/providers.md

+4-77
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Installation and Usage
2-
SMODERP has been adapted to work seamlessly with various Geographic Information System (GIS) platforms. Instalation for QGIS, GRASS GIS, and ArcGIS is decribed below.
1+
# Providers and install
2+
SMODERP has been adapted to work seamlessly with various Geographic Information System (GIS) platforms. Instalation for QGIS, GRASS GIS, and ArcGIS is decribed here.
33

4-
## QGIS Plugin
4+
## QGIS - Plugin
55
In QGIS, the plugin repository is a central storage location where users can access and manage plugins that extend the functionality of the QGIS application. SMODERP are acessed from this repository.
66
### Installation instructions
77

@@ -39,7 +39,7 @@ toolbar ![](./img/qgis_plugin_icon.png).
3939
* Download latest SMODERP2D version: <https://github.com/storm-fsv-cvut/smoderp2d/releases>
4040
* Open GRASS Addon located in ``bin/grass/r.smoderp2d/r.smoderp2d.py``
4141

42-
## ArcGIS Pro Toolbox
42+
## ArcGIS Pro - Toolbox
4343
In the ArcGIS environment are a toolboxes a collection of geoprocessing tools. SMODERP are developed as extend tolbox of the ArcGIS software.
4444

4545
### Installation instructions
@@ -62,76 +62,3 @@ Computation options and Advanced menu
6262

6363
History runs are stored in **History** of ArcGIS Pro project.
6464

65-
## Batch processing
66-
67-
First, download SMODERP2D from GitHub repository
68-
<https://github.com/storm-fsv-cvut/smoderp2d>.
69-
70-
Batch processing may be run as a single process or multiple processes
71-
defined by a CSV file.
72-
73-
To run batch process GRASS GIS is required.
74-
75-
!!! note
76-
77-
Note that on MS Windows GRASS GIS is part of the QGIS
78-
installation. In this case there is no need to install GRASS GIS
79-
separately.
80-
81-
You only need to adjust the installation path in
82-
`tests/batch/init_windows_env.bat` file:
83-
84-
- OSGeo4W installation
85-
```
86-
set INSTALL_DIR=C:\OSGeo4W
87-
```
88-
89-
- QGIS standalone installation
90-
```
91-
set INSTALL_DIR=C:\Program Files\QGIS 3.36.2\
92-
```
93-
94-
You may also need to adjust GRASS version (in example below GRASS
95-
8.3 is expected to be installed):
96-
```
97-
set GRASS_VERSION=83
98-
```
99-
100-
### Single process
101-
102-
Open `batch_process_single.bat` (or `batch_process_single_linux.sh` on
103-
GNU/Linux) located in `tests/batch` directory and adjust input
104-
parameters. Then run the script.
105-
106-
### Multiple processes
107-
108-
Multiple processes may be defined by a CSV file, for example see
109-
`tests/batch/batch_process.csv` file.
110-
111-
!!! note
112-
113-
If the content of the first cell starts with `#`, the process is skipped.
114-
115-
Adjust parameters in your CSV file and run `batch_process_csv.bat` (or
116-
`batch_process_csv_linux.sh` on GNU/Linux) located in `tests/batch`
117-
directory.
118-
119-
!!! tip
120-
121-
Processes may be run in parallel. Number of workers is defined in
122-
the script:
123-
124-
```
125-
--workers 1
126-
```
127-
128-
Note that for parallel processing (ie. number of workers > 1)
129-
[Joblib](https://joblib.readthedocs.io/en/stable/) Python package
130-
is required. The package may be installed on Windows by
131-
`install_joblib_windows.bat` located in `tests/batch`.
132-
133-
WARNING: parallel processing is experimental and may have various
134-
problems.
135-
136-
137-

user_guide/mkdocs.yml

+1-4
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,7 @@ markdown_extensions:
1919
- attr_list
2020
- md_in_html
2121
- toc:
22-
permalink:
23-
- admonition
24-
- pymdownx.details
25-
- pymdownx.superfences
22+
permalink:
2623
plugins:
2724
- glightbox
2825
- search

user_guide/requirements.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
mkdocs
22
mkdocs-glightbox
33
mkdocs-table-reader-plugin
4-
pymdown-extensions

0 commit comments

Comments
 (0)