aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md105
1 files changed, 105 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7713635
--- /dev/null
+++ b/README.md
@@ -0,0 +1,105 @@
+Summary
+=======
+
+Script to create a QGIS project with observations of Plantae and Fungi
+from [SLU Artdatabanken][].
+
+Observations are retrieved using SLU Artdatabanken's [Species Observation System API][],
+which aggregates data from multiple sources such as [Artportalen][]
+and [MVM environmental data][].
+
+Background topographic maps from [Lantmäteriet][Lantmäteriet Product List].
+
+[SLU Artdatabanken]: https://www.artdatabanken.se/
+[Species Observation System API]: https://www.artdatabanken.se/tjanster-och-miljodata/oppna-data-och-apier/om-artdatabankens-apier/api-for-artobservationer-fran-flera-datakallor/
+[Artportalen]: https://artportalen.se
+[MVM environmental data]: https://miljodata.slu.se/mvm/
+[Lantmäteriet Product List]: https://www.lantmateriet.se/sv/geodata/vara-produkter/produktlista/#category=geografiskinformation.
+
+
+Usage
+=====
+
+```
+$ gis-observation-map --help
+usage: gis-observation-map --project-home=DIR --project-name=NAME {--geometry=FILE|--point=Y,X} ...
+ gis-observation-map --observation-file=NAME {--geometry=FILE|--point=Y,X} ...
+
+Create a QGIS project with observations from Artdatabanken.
+
+options:
+ -h, --help show this help message and exit
+ --project-home DIRECTORY
+ Project home directory
+ --project-name NAME Project filename (and title) relative to --project-home
+ --topo-basedir DIRECTORY
+ Base directory for "Topografi 10", "Topografi 50", etc.
+
+Geographic area of interest:
+ --geometry-style STYLE_FILE
+ QGIS Layer Style File (*.qml) to apply to subsequent geometry files
+ --geometry-layername NAME
+ Layer names for subsequent geometry files
+ --geometry GEOMETRY_FILE
+ Geometry file of interest
+ --point [Y,X ...] Coordinates of interest (in SWEREF99 TM)
+ --margin N Margin (in meters) around geometry envelopes
+
+Observations:
+ --no-observations Do not fetch observations within the area(s) of interest
+ --observation-file NAME
+ Observation file name relative to --project-home
+ --observation-format FORMAT
+ Format for the observation file
+ --observation-style STYLE_FILE
+ QGIS Layer Style File (*.qml) to apply to the observation layer (default: ~/gis/Inventeringar/fynd.qml)
+
+Search filter:
+ --data-provider [IDENTIFIER ...]
+ Data provider identifier(s), for instance "Artportalen,MVM"
+ --since YYYY-MM-DD Start date for observations in ISO 8601 format
+ --until YYYY-MM-DD End date for observations in ISO 8601 format
+```
+
+Examples
+========
+
+Map with observations found in a 10km-wide square centered around
+Jokkmokk, Norrbotten.
+
+```
+$ gis-observation-map --margin 5000 --point 7395788,713523 \
+ --project-name=Jokkmokk --project-home=/path/to/Jokkmokk
+1516 observations found
+```
+
+![Jokkmokk](img/jokkmokk.png)
+
+
+Map with observations in or nearby [exploration permits and processing
+concessions][SGU Mineralrättigheter].
+
+```
+$ gis-observation-map --margin 2500 \
+ --geometry-style /path/to/Mineralrättigheter.qml --geometry /path/to/jokkmokk-sgu.geojson \
+ --project-name=Gruvor --project-home=/path/to/Jokkmokk-Mineral
+5304 observations found
+```
+
+Zoom in on the Gállok area (Jokkmokk Municipality, Norrbotten).
+
+![Gállok](img/gallok.png)
+
+Showing details for a specific observation near Doaresoajvve (Jokkmokk
+Municipality, Norrbotten).
+
+![Doaresoajvve](img/doaresoajvve.png)
+
+[SGU Mineralrättigheter]: https://apps.sgu.se/kartvisare/kartvisare-mineralrattigheter.html
+
+[Contribute](https://git.guilhem.org/gis-observation-map/about/)
+============
+
+```
+$ git clone https://git.guilhem.org/gis-observation-map.git
+```