Fix 549 docs on user defined output path

CHANGELOG.md

@@ -10,6 +10,8 @@ and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/
 ### Added
 ### Changed
 - Fix usercff workflow [#545](https://github.com/OpenEnergyPlatform/open-MaStR/issues/544)
+- Fix docs on user-defined output path for csv, xml, database
+  [#549](https://github.com/OpenEnergyPlatform/open-MaStR/issues/549)
 ### Removed
 
 ## [v0.14.4] Release for the Journal of Open Source Software JOSS - 2024-06-07

CITATION.cff

@@ -25,6 +25,11 @@ authors:
     alias: "@deniztepe"
     affiliation: "fortiss"
     orcid: " https://orcid.org/0000-0002-7605-0173"
+  - family-names: "Amme"
+    given-names: "Jonathan"
+    alias: "@nesnoj"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: " https://orcid.org/0000-0002-8563-5261"
 title: "open-MaStR"
 type: software
 license: AGPL-3.0

docs/advanced.md

@@ -28,6 +28,7 @@ The possible databases are:
 ### Project directory
 
 The directory `$HOME/.open-MaStR` is automatically created. It is used to store configuration files and save data.
+You can change this default path, see [environment variables](#environment-variables).
 Default config files are copied to this directory which can be modified - but with caution.
 The project home directory is structured as follows (files and folders below `data/` just an example).
 
@@ -87,6 +88,15 @@ The data can then be written to any sql database supported by [sqlalchemy](https
 For more information regarding the database see [Database settings](#database-settings).
 
 
+### Environment variables
+
+There are some environment variables to customize open-MaStR:
+
+| Variable               | Description                                                                                                                                                              | Example                                                                                                                    |
+|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
+| `SQLITE_DATABASE_PATH` | Path to the SQLite file. This allows to use to use multiple instances of the MaStR database. The database instances exist in parallel and are independent of each other. | `/home/mastr-rabbit/.open-MaStR/data/sqlite/your_custom_instance_name.db`                                                  |
+| `OUTPUT_PATH`          | Path to user-defined output directory for CSV data, XML file and database. If not specified, output directory defaults to `$HOME/.open-MaStR/`                           | Linux: `/home/mastr-rabbit/open-mastr-user-defined-output-path`, Windows: `C:\\Users\\open-mastr-user-defined-output-path` |
+
 ## Bulk download
 
 On the homepage [MaStR/Datendownload](https://www.marktstammdatenregister.de/MaStR/Datendownload) a zipped folder containing the whole

pyproject.toml

@@ -25,13 +25,15 @@ authors = [
   {name = "Muschner Christoph"},
   {name = "Kotthoff Florian"},
   {name = "Tepe Deniz"},
+  {name = "Amme Jonathan"},
   {name = "Open Energy Family"},
 ]
 
 maintainers = [
   {name = "Ludwig Hülk", email = "[email protected]"},
   {name = "Florian Kotthoff"},
-  {name = "Christoph Muschner", email = "[email protected]"}  
+  {name = "Christoph Muschner", email = "[email protected]"},
+  {name = "Jonathan Amme", email = "[email protected]"}
 ]
 description = "A package that provides an interface for downloading and processing the data of the Marktstammdatenregister (MaStR)"
 readme = "README.rst"