improve documentation (OSS)

swisstopo · Dec 4, 2024 · 23cda82 · 23cda82 · github-actions · Dec 4, 2024
1 parent d9480ce
commit 23cda82
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -74,15 +74,23 @@ IS_SEARCHING_GROUNDWATER_ILLUSTRATION="True"
 
 The extraction of groundwater relies on the `scikit-image` library. This library is part of the optional dependencies of this project as part of the `groundwater_illustration_matching` dependencies in the `pyproject.toml` file. If you wish to use the template matching algorithm to determine the groundwater elevation, depth, and date, please install this dependency before running the code. 
 
-## Main contributors
+## Project management
+
+This project is managed and financed by the Swiss Federal Office of Topography [swisstopo](https://www.swisstopo.admin.ch/). Many contributions come from [Visium](https://www.visium.ch/), in their role as contractor for swisstopo for this project.
+
+This project is released as open source software, under the principle of "_public money, public code_", in accordance with the 2023 federal law "[_EMBAG_](https://www.fedlex.admin.ch/eli/fga/2023/787/de)", and following the guidance of the [tools for OSS published by the Federal Chancellery](https://www.bk.admin.ch/bk/en/home/digitale-transformation-ikt-lenkung/bundesarchitektur/open_source_software/hilfsmittel_oss.html).
+
+We welcome feedback, bug reports and code contributions (provided they are compatible with swisstopo's roadmap) from third parties. Feature requests and support requests can only be fulfilled as long as they are compatible with swisstopo's legal mandate. Other organisations (both within Switzerland or internationally) who manage their own borehole data and are interested in using and/or contributing to this project, are encouraged to contact us, in order to discuss the possibility of establishing a partnership for collaborating more closely on this project.
+
+### Main contributors
 
 * Stijn Vermeeren [@stijnvermeeren-swisstopo](https://www.github.com/stijnvermeeren-swisstopo) (swisstopo) - Project Lead
 * David Cleres [@dcleres](https://www.github.com/dcleres) (Visium)
 * Renato Durrer [@redur](https://www.github.com/redur) (Visium)
 
-## License
+### License
 
-The source code of this project is open source software, licensed under the [MIT License](LICENSE). Certain libraries in the project dependencies might be distributed under more restrictive open source licenses. Most notably, [PyMuPDF](https://pymupdf.readthedocs.io/en/latest/about.html#license-and-copyright) is available under either the AGPL license or a commercial license. These more restrictive licenses would apply when distributing this project in a single package together with its dependencies.
+The source code of this project is licensed under the [MIT License](LICENSE). Certain libraries in the project dependencies might be distributed under more restrictive open source licenses. Most notably, [PyMuPDF](https://pymupdf.readthedocs.io/en/latest/about.html#license-and-copyright) is available under either the AGPL license or a commercial license. These more restrictive licenses would apply when distributing this project in a single package together with its dependencies.
 
 ## Installation
 We use pip to manage the packages dependencies. We recommend using a virtual environment within which to install all dependencies.

diff --git a/src/stratigraphy/groundwater/utility.py b/src/stratigraphy/groundwater/utility.py
@@ -28,7 +28,7 @@ def extract_depth(text: str, max_depth: int) -> float | None:
         float: The extracted depth.
     """
     depth_patterns = [
-        r"([\d.]+)\s*m\s*u\.t\.",
+        r"([\d.]+)\s*m\s*u\.t\.",  # e.g. "5.13 m u.T."
         r"([\d.]+)\s*m\s*u\.t",
         r"(\d+.\d+)",
     ]
File	Stmts	Miss	Cover	Missing
src/stratigraphy
__init__.py	8	1	88%	11
extract.py	167	167	0%	3–446
get_files.py	19	19	0%	3–47
main.py	114	114	0%	3–307
src/stratigraphy/benchmark
metrics.py	59	42	29%	22–25, 29–32, 36–39, 46–49, 53–54, 58, 65–74, 78–91, 96–133
src/stratigraphy/data_extractor
data_extractor.py	74	4	95%	33, 46, 123, 168
src/stratigraphy/depth
a_to_b_interval_extractor.py	37	15	59%	41–60, 79, 92
depthcolumnentry.py	15	3	80%	19, 23, 35
depthcolumnentry_extractor.py	23	2	91%	44–45
interval.py	101	52	49%	26–29, 34–37, 43, 49, 53, 92–138, 159, 165–181
src/stratigraphy/depths_materials_column_pairs
bounding_boxes.py	30	10	67%	23, 32, 50, 60, 72–78
material_description_rect_with_sidebar.py	18	8	56%	27–41
src/stratigraphy/evaluation
evaluation_dataclasses.py	49	11	78%	52, 71–74, 90, 104, 125–131, 147
groundwater_evaluator.py	48	1	98%	77
layer_evaluator.py	66	46	30%	29–30, 35–39, 47, 69–95, 105–113, 128–149
metadata_evaluator.py	37	14	62%	46–65, 86–93
utility.py	16	7	56%	43–52
src/stratigraphy/groundwater
groundwater_extraction.py	156	99	37%	52, 94, 127–132, 140, 167–171, 186–206, 217–306, 322–354
utility.py	39	33	15%	10–17, 30–47, 59–73, 88–102
src/stratigraphy/layer
layer.py	36	13	64%	25, 28, 36, 51–71
src/stratigraphy/lines
geometric_line_utilities.py	86	2	98%	81, 131
line.py	51	4	92%	25, 50, 60, 110
linesquadtree.py	46	1	98%	75
src/stratigraphy/metadata
coordinate_extraction.py	106	4	96%	29, 93–94, 106
elevation_extraction.py	90	60	33%	34–39, 47, 55, 63, 79–87, 124–138, 150–153, 165–197, 212–220, 228–232
language_detection.py	18	13	28%	17–23, 37–45
metadata.py	66	24	64%	27, 83, 101–127, 146–155, 195–198, 206
src/stratigraphy/sidebar
a_above_b_sidebar.py	94	40	57%	38, 44, 63–71, 82, 87, 94, 107, 112–119, 134–135, 177–218
a_above_b_sidebar_extractor.py	29	3	90%	46–48
a_above_b_sidebar_validator.py	41	20	51%	48, 58, 61, 81–84, 109–127, 139–148
a_to_b_sidebar.py	43	14	67%	36, 49–50, 67, 95–108
layer_identifier_sidebar.py	51	32	37%	23–24, 27, 59–78, 94–110, 122, 135
layer_identifier_sidebar_extractor.py	41	33	20%	30–40, 54–86
sidebar.py	40	1	98%	84
src/stratigraphy/text
description_block_splitter.py	70	2	97%	24, 139
extract_text.py	29	3	90%	19, 53–54
find_description.py	41	8	80%	26–34, 111–114
textblock.py	90	11	88%	22, 27, 39, 44, 71, 79, 104, 116, 139, 160, 189
src/stratigraphy/util
dataclasses.py	32	3	91%	37–39
predictions.py	72	34	53%	72, 95–115, 143–187
util.py	34	13	62%	41, 69–76, 90–92, 116–117
TOTAL	2373	986	58%