Create SettlementRodMeasurement and SettlementRodMeasurementSeries classes

.github/workflows/lint_test.yaml

@@ -38,21 +38,21 @@ jobs:
       - name: Test
         run: coverage run -m pytest
 
-      - name: Post coverage results
-        uses: coverallsapp/github-action@v2
-        with:
-          flag-name: run-${{ matrix.python-version }}
-          parallel: true
-
-  finish:
-    needs: test
-    if: ${{ always() }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Coveralls Finished
-        uses: coverallsapp/github-action@v2
-        with:
-          parallel-finished: true
+  #     - name: Post coverage results
+  #       uses: coverallsapp/github-action@v2
+  #       with:
+  #         flag-name: run-${{ matrix.python-version }}
+  #         parallel: true
+
+  # finish:
+  #   needs: test
+  #   if: ${{ always() }}
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Coveralls Finished
+  #       uses: coverallsapp/github-action@v2
+  #       with:
+  #         parallel-finished: true
 
   lint:
     name: Formatting check

docs/conf.py

@@ -37,6 +37,7 @@
     "sphinx.ext.mathjax",
     "sphinx_autodoc_typehints",
     "matplotlib.sphinxext.plot_directive",
+    "enum_tools.autoenum",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/index.rst

@@ -14,4 +14,4 @@ Indices and tables
 
    tree/getting_started.rst
 
-
+   tree/reference.rst

docs/tree/reference.rst

@@ -0,0 +1,76 @@
+.. _reference:
+
+Reference
+=========
+
+.. _settlementRodMeasurement:
+
+Settlement Rod Measurement
+----------------------------
+
+A settlement rod device consists of a rod and a (bottom) settlement plate (see figure below). The measurements are taken at the top of the rod (i.e. `rod_top`) 
+and at the `ground surface` and since the `rod length` is known, the settlement of at the bottom of the rod (i.e. `rod_bottom`) can be also derived.
+
+.. image:: figures/settlement_rod.png
+
+The class `SettlementRodMeasurement` presented below stores the data of a single settlement rod measurement.
+
+.. autoclass:: baec.measurements.settlement_rod_measurement.SettlementRodMeasurement
+    :members:
+    :inherited-members:
+    :member-order: bysource
+
+    .. automethod:: __init__
+
+.. autoenum:: baec.measurements.settlement_rod_measurement.SettlementRodMeasurementStatus
+    :members:
+
+
+.. _settlementRodMeasurementSeries:
+
+Settlement Rod Measurement Series
+---------------------------------
+
+.. autoclass:: baec.measurements.settlement_rod_measurement_series.SettlementRodMeasurementSeries
+    :members:
+    :inherited-members:
+    :member-order: bysource
+
+    .. automethod:: __init__
+
+
+.. _measurementDevice:
+
+Measurement Device
+------------------
+
+.. autoclass:: baec.measurements.measurement_device.MeasurementDevice
+    :members:
+    :inherited-members:
+    :member-order: bysource
+
+    .. automethod:: __init__
+
+.. _project:
+
+Project
+-------
+
+.. autoclass:: baec.project.Project
+    :members:
+    :inherited-members:
+    :member-order: bysource
+
+    .. automethod:: __init__
+
+CoordinateReferenceSystems
+--------------------------
+
+.. _coordinateReferenceSystems:
+
+.. autoclass:: baec.coordinates.CoordinateReferenceSystems
+    :members:
+    :inherited-members:
+    :member-order: bysource
+
+    .. automethod:: __init__

pyproject.toml

@@ -13,6 +13,7 @@ dependencies = [
     'cems-nuclei[client]>=0.5,<1',
     'matplotlib>=3.8,<4',
     "tqdm[notebook]>4,<5",
+    "pyproj>3,<4",
 ]
 license = { file = "LICENSE" }
 readme = "README.md"
@@ -28,7 +29,8 @@ docs = [
     "sphinx-autodoc-typehints==1.22",
     "ipython==8.11.0",
     "asteroid-sphinx-theme==0.0.3",
-    "sphinx_rtd_theme==1.2.0",
+    "sphinx_rtd_theme>1.2,<2",
+    "enum-tools[sphinx]>0.12,<0.13",
 ]
 # lint dependencies from github super-linter v5
 # See https://github.com/super-linter/super-linter/tree/main/dependencies/python
@@ -62,7 +64,7 @@ ensure_newline_before_comments = true
 line_length = 88
 
 [tool.mypy]
-files = ["src/pypilecore"]
+files = ["src/baec"]
 mypy_path = 'src'
 namespace_packages = true
 show_error_codes = true
@@ -84,10 +86,8 @@ module = [
     "matplotlib.*",
     "requests.*",
     "nuclei.*",
-    "pygef.*",
-    "natsort.*",
-    "shapely.*",
     "pytest.*",
     "scipy.*",
+    "pyproj.*",
 ]
 ignore_missing_imports = true