Merge pull request #349 from LuposX/dev

Dev

.coveragerc

@@ -0,0 +1,25 @@
+[paths]
+source =
+   src/osm_configurator
+
+[run]
+branch = true
+parallel = true
+source =
+    src_tests
+
+[report]
+show_missing = true
+precision = 2
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+    import .*
+    from .* import .*
+     # abstractmethod are for us never implemented
+    @abstract
+    @abstractmethod
+
+[html]
+directory = coverage_html_report

.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
     - name: Setup Conda
       uses: conda-incubator/setup-miniconda@v2
       with:
-        environment-file: PSE.yml
+        environment-file: enviroment.yml
         miniforge-version: latest
         miniforge-variant: Mambaforge
         use-mamba: true

.gitignore

@@ -3,6 +3,9 @@
 __pycache__
 src_tests/build
 
+# the project
+venv
+
 ## Core latex/pdflatex auxiliary files:
 *.aux
 *.lof

README.rst

@@ -31,22 +31,14 @@ For each of the phases of the watferfall model you can find the documentation in
 
 
 For a more specific description of the code, check the ``README.md`` in
-the subfolder `pythoncode`.
+the subfolder ``src``.
 
 Installation
 ------------
 
-.. note
-   Not implemented yet.
-
-We recommend installing KonfiguratorFuerOSMDaten 
-using one of the available built distributions, 
-for example using ``pip`` or ``conda``:
-
-.. code-block:: console
-
-    Here will stand sth. in the future
-
+You can download the binary(which is for windows only) from the release tab.
+If you want to built the program from source check out the `README.md <https://github.com/LuposX/KonfiguratorFuerOSMDaten/blob/main/src/README.md>`__ in
+the subfolder ``src``.
 
 Usage
 -----
@@ -61,13 +53,14 @@ License
 KonfiguratorFuerOSMDaten is licensed under the GPLv3 `License 
 <https://github.com/LuposX/KonfiguratorFuerOSMDaten/blob/main/LICENSE>`__.
 
-Contribution
-------------
 
-To contribute to the project:
+Contributions
+-------------
+
+This project was made in collaberation with these amazing people:
 
-1. Fork it (https://github.com/LuposX/KonfiguratorFuerOSMDaten/fork)
-2. Create your feature branch (``git checkout -b feature/fooBar``)
-3. Commit your changes (``git commit -am 'Add some fooBar'``)
-4. Push to the branch (``git push origin feature/fooBar``)
-5. Create a new Pull Request
+- `Felix Weik <https://github.com/FelixWeik>`__  
+- `Jan-Philipp Hansen <https://github.com/ujrlh>`__  
+- `Karl Bernhard <https://github.com/GloeStoe>`__  
+- `Pascal Dawideit <https://github.com/calliminator>`__  
+- `Simon Schupp <https://github.com/LuposX>`__  

data/osmium/info_on_osmium.md

@@ -0,0 +1,8 @@
+## About this folder
+
+The tool [osmium](https://github.com/osmcode/osmium-tool) in this folder is used to split up one big osm data file into
+multiple smaller ones, for better further processing.
+
+## Source
+
+Source for the [build files](https://github.com/pango3001/Osmium_1_14).

PSE.yml → enviroment.yml

@@ -266,4 +266,4 @@ dependencies:
       - wcwidth==0.2.6
       - webcolors==1.12
       - webencodings==0.5.1
-      - websocket-client==1.4.2
+      - websocket-client==1.4.2