Merge branch 'feature/docs' of https://github.com/Deltares-research/g…

…eost into feature/docs
Deltares-research · Dec 4, 2024 · ece3d4c · ece3d4c
2 parents 73399b6 + 76f8352
commit ece3d4c
Show file tree

Hide file tree

Showing 23 changed files with 612 additions and 121 deletions.
diff --git a/.gitignore b/.gitignore
@@ -109,6 +109,7 @@ ENV/
 *.gml
 *.dbf
 
+!data/*.nc
 
 # data
 #*.xml

diff --git a/data/geotop_usp.nc b/data/geotop_usp.nc
diff --git a/docs/api_reference.md b/docs/api_reference.md
@@ -16,8 +16,9 @@ Input/Output <api_reference/io>
 VoxelModel <api_reference/voxelmodel>
 BroApi <api_reference/bro>
 GeoTop <api_reference/bro_geotop>
-StratGeotop <api_reference/strat_geotop.rst>
+GeoTop selection <api_reference/geotop_selection.rst>
 Analysis <api_reference/analysis>
 Utils <api_reference/utils>
+Enums <api_reference/enums>
 ```
 
diff --git a/docs/api_reference/analysis.rst b/docs/api_reference/analysis.rst
@@ -1,10 +1,10 @@
 Analysis
-========
+==========
 
 .. currentmodule:: geost.analysis
 
 Boreholes
----------
+-----------
 .. autosummary::
    :toctree: generated/
 
@@ -15,9 +15,17 @@ Boreholes
 
 
 Cpts
-----
+------
 .. autosummary::
     :toctree: generated/
 
     interpret_cpt.calc_ic
-    interpret_cpt.calc_lithology
+    interpret_cpt.calc_lithology
+
+
+Combine
+--------
+.. autosummary::
+    :toctree: generated/
+
+    combine.add_voxelmodel_variable
diff --git a/docs/api_reference/bro.rst b/docs/api_reference/bro.rst
@@ -12,7 +12,7 @@ Constructor
 
 
 Methods
-~~~~~~~
+--------
 .. autosummary::
    :toctree: generated/
 

diff --git a/docs/api_reference/enums.rst b/docs/api_reference/enums.rst
@@ -0,0 +1,14 @@
+Enums
+=============
+.. currentmodule:: geost.enums
+
+
+UnitEnum
+---------
+.. autosummary::
+   :toctree: generated/
+
+   UnitEnum
+   UnitEnum.select_units
+   UnitEnum.select_values
+   UnitEnum.to_dict
diff --git a/docs/api_reference/geotop_selection.rst b/docs/api_reference/geotop_selection.rst
@@ -0,0 +1,24 @@
+GeoTop selection
+=================
+.. currentmodule:: geost.bro.bro_geotop
+
+StratGeotop
+------------
+.. autosummary::
+   :toctree: generated/
+
+   StratGeotop
+   StratGeotop.select_units
+   StratGeotop.select_values
+   StratGeotop.to_dict
+
+
+Lithology
+----------
+.. autosummary::
+   :toctree: generated/
+
+   Lithology
+   Lithology.select_units
+   Lithology.select_values
+   Lithology.to_dict
diff --git a/docs/api_reference/strat_geotop.rst b/docs/api_reference/strat_geotop.rst
diff --git a/docs/api_reference/utils.rst b/docs/api_reference/utils.rst
@@ -15,8 +15,6 @@ Spatial
     spatial.select_points_near_points
     spatial.select_points_within_bbox
     spatial.select_points_within_polygons
-    models.model_utils.sample_along_line
-    models.model_utils.sample_with_coords
 
 Projection
 ----------
@@ -26,3 +24,13 @@ Projection
     projections.horizontal_reference_transformer
     projections.vertical_reference_transformer
     projections.xy_to_ll
+
+
+Model Utils
+------------
+.. autosummary::
+    :toctree: generated/
+
+    models.model_utils.label_consecutive_2d
+    models.model_utils.sample_with_coords
+    models.model_utils.sample_along_line
diff --git a/docs/examples/combine_geotop_with_cpts.ipynb b/docs/examples/combine_geotop_with_cpts.ipynb
diff --git a/docs/user_guide.md b/docs/user_guide.md
@@ -7,6 +7,7 @@ caption: User guide
 
 Data structures <user_guide/data_structures>
 Reading data <user_guide/reading_data>
+BRO GeoTOP <user_guide/bro_geotop.ipynb>
 ```
 
 This is the user guide.
-Original file line number
+Diff line change
@@ Expand Up / @@ -109,6 +109,7 @@ ENV/ @@
     *.gml
     *.dbf
+    !data/*.nc
     # data
     #*.xml
@@ Expand Down @@