docs: add general pipeline to getting stated page

.gitignore

@@ -72,6 +72,7 @@ instance/
 # Sphinx documentation
 docs/_build/
 public/
+docs/savefig/
 
 # PyBuilder
 .pybuilder/

docs/_static/data/E790M.csv

@@ -0,0 +1,47 @@
+E790M,10/30/2014,0,-0.223,-2.223,-2.052,0.000,0.000,0.000,106111.838,449128.498
+E790M,11/5/2014,0,-0.246,-2.246,-1.057,0.023,1.018,0.247,106111.646,449128.653
+E790M,11/13/2014,0,-0.290,-2.290,-1.182,0.067,0.937,0.680,106111.854,449127.818
+E790M,11/21/2014,0,-0.266,-2.266,-1.203,0.043,0.892,0.494,106111.911,449128.009
+E790M,12/18/2014,0,-0.277,-2.277,-1.087,0.054,1.019,0.504,106111.547,449128.087
+E790M,1/7/2015,0,-0.303,-2.303,-1.118,0.080,1.014,0.541,106111.412,449128.164
+E790M,1/16/2015,0,-0.322,-2.322,-1.103,0.099,1.048,0.087,106111.867,449128.416
+E790M,1/21/2015,0,1.622,-2.378,-0.699,0.155,1.508,0.248,106111.898,449128.257
+E790M,1/28/2015,0,1.607,-2.393,-0.684,0.170,1.538,0.501,106111.434,449128.202
+E790M,2/4/2015,0,1.533,-2.467,0.022,0.244,2.318,0.644,106111.433,449127.997
+E790M,2/11/2015,0,1.466,-2.534,-0.016,0.311,2.347,0.109,106111.872,449128.394
+E790M,2/19/2015,0,1.432,-2.568,-0.093,0.345,2.304,0.337,106111.511,449128.415
+E790M,2/27/2015,0,1.407,-2.593,-0.119,0.370,2.303,0.636,106111.563,449127.924
+E790M,3/6/2015,0,1.342,-2.658,0.530,0.435,3.017,0.755,106112.058,449127.776
+E790M,3/13/2015,0,1.247,-2.753,0.506,0.530,3.088,0.751,106112.000,449127.765
+E790M,3/20/2015,0,1.230,-2.770,0.462,0.547,3.061,0.804,106111.923,449127.699
+E790M,3/27/2015,0,1.175,-2.825,0.409,0.602,3.063,0.276,106111.565,449128.460
+E790M,4/3/2015,0,1.149,-2.851,0.366,0.628,3.046,0.385,106111.529,449128.268
+E790M,4/10/2015,0,1.110,-2.890,0.347,0.667,3.066,0.387,106111.515,449128.285
+E790M,5/1/2015,5,2.934,-3.066,0.883,0.843,3.778,0.568,106111.934,449127.938
+E790M,5/12/2015,1,2.795,-3.205,2.326,0.982,5.360,0.546,106111.937,449127.961
+E790M,5/23/2015,1,2.638,-3.362,2.405,1.139,5.596,0.519,106111.964,449127.995
+E790M,5/28/2015,1,2.597,-3.403,2.315,1.180,5.547,0.535,106112.001,449127.988
+E790M,6/2/2015,1,2.543,-3.457,2.279,1.234,5.565,0.560,106112.032,449127.973
+E790M,6/10/2015,1,2.470,-3.530,2.228,1.307,5.587,0.640,106112.008,449127.881
+E790M,6/17/2015,1,2.441,-3.559,2.213,1.336,5.601,0.573,106112.029,449127.958
+E790M,6/23/2015,5,4.407,-3.593,2.173,1.370,5.595,0.792,106112.318,449127.868
+E790M,7/3/2015,1,4.372,-3.628,2.182,1.405,5.639,0.699,106112.180,449127.888
+E790M,7/13/2015,5,2.352,-3.648,2.125,1.425,5.602,0.593,106112.121,449127.977
+E790M,7/23/2015,5,4.295,-3.705,2.119,1.482,5.653,0.831,106112.343,449127.838
+E790M,7/30/2015,1,4.270,-3.730,2.110,1.507,5.669,0.673,106112.233,449127.953
+E790M,8/14/2015,1,4.223,-3.777,2.098,1.554,5.704,0.679,106112.235,449127.947
+E790M,8/20/2015,1,4.218,-3.782,2.042,1.559,5.653,0.692,106112.280,449127.965
+E790M,8/26/2015,1,4.199,-3.801,2.012,1.578,5.642,0.789,106112.216,449127.806
+E790M,9/8/2015,1,4.175,-3.825,2.037,1.602,5.691,0.670,106112.259,449127.977
+E790M,9/15/2015,1,4.179,-3.821,1.988,1.598,5.638,0.677,106112.227,449127.944
+E790M,9/22/2015,1,4.140,-3.860,1.914,1.637,5.603,0.601,106112.090,449127.952
+E790M,9/29/2015,1,4.135,-3.865,1.970,1.642,5.664,0.611,106112.090,449127.941
+E790M,10/6/2015,1,4.144,-3.856,1.922,1.633,5.607,0.703,106112.096,449127.844
+E790M,10/13/2015,1,4.088,-3.912,1.897,1.689,5.638,0.624,106112.138,449127.951
+E790M,10/22/2015,1,4.100,-3.900,1.855,1.677,5.584,0.643,106112.180,449127.953
+E790M,10/28/2015,1,4.082,-3.918,1.826,1.695,5.573,0.641,106112.137,449127.931
+E790M,11/5/2015,1,4.060,-3.940,1.782,1.717,5.551,0.816,106112.237,449127.786
+E790M,11/9/2015,1,4.053,-3.947,1.804,1.724,5.580,0.584,106112.055,449127.956
+E790M,11/10/2015,1,4.062,-3.938,1.790,1.715,5.557,0.647,106112.133,449127.922
+E790M,11/16/2015,1,4.041,-3.959,1.785,1.736,5.573,0.651,106112.116,449127.909
+E790M,11/25/2015,1,4.030,-3.970,1.788,1.747,5.587,0.657,106112.099,449127.895

docs/index.rst

@@ -1,7 +1,29 @@
 Welcome to BAEC Model Generator SDK documentation!
 ==================================================
 
-The `baec` library is created by `CEMS BV <https://cemsbv.nl/>`_ .
+`Basetime <https://basetime.nl/>`_ and `CEMS BV <https://cemsbv.nl/>`_ are working
+together on the development of the BAEC system/platform (Soil Movement Acquisition
+and Extrapolation of Continuous
+Measurements System, for its initials in Dutch Bodembeweging Acquisitie en
+Extrapolatie van Continuemetingen), an advanced geotechnical measuring
+system that improves the accuracy and reliability of settlement measurements
+and predictions in the Netherlands.
+
+BAEC uses advanced sensor technology, wireless communications and data
+analysis to provide real-time insight into ground movements.
+
+This system innovates by combining automatic, accurate and high-frequency
+measurements of ground movement with analysis of subsidence measurement data
+and short- and long-term forecasts. This addresses the problem of uncertainty
+margins in settlement calculations, caused by heterogeneous soil compositions,
+allowing for earlier and better decision making in the advance of construction
+projects.
+
+The BAEC system responds to increasing drought and flooding in the Netherlands,
+which have consequences for the built environment and the groundwater level.
+Furthermore, it anticipates the need for accurate measurements and predictions in a
+digitized construction industry with a workforce shortage.
+
 
 Indices and tables
 ==================

docs/tree/getting_started.rst

@@ -1,7 +1,85 @@
 Getting started
 ===============
 
+The easiest way to get started with `baec` is in the **Jupyter Notebook**.
 
 Installation
--------------
-TODO
+------------
+To install this package, including the `basetime` reading functionality, run:
+
+.. code-block::
+
+    pip install baec[aws]
+
+
+To skip the installation of the optional library, in case you do not need it
+(e.g. not connecting to the aws server), run:
+
+.. code-block::
+
+    pip install baec
+
+Than you can import `baec` as follows:
+
+.. ipython:: python
+
+    import os
+
+    import matplotlib.pyplot as plt
+    import pandas as pd
+
+    from baec.measurements.io.zbase import measurements_from_zbase
+
+or any equivalent :code:`import` statement.
+
+SettlementRodMeasurementSeries
+--------------------------------
+
+The first thing to do is to create `SettlementRodMeasurementSeries` classes.
+This class holds the information of a selection of `Measurements`.
+
+For more information on the :func:`baec.measurements.settlement_rod_measurement_series
+.SettlementRodMeasurementSeries` class go the the reference.
+
+
+.. ipython:: python
+
+    root = os.environ["DOC_PATH"]
+    filepath = os.path.join(root, "_static/data/E790M.csv")
+
+    # Create series from zbase csv file
+    measurements = measurements_from_zbase(
+        filepath_or_buffer=filepath, project_name="Docs"
+    )
+
+    # plot measurements
+    @savefig measurements.png
+    measurements.plot_z_time()
+
+
+MeasuredSettlementSeries
+--------------------------------
+
+The next step is to transform the `SettlementRodMeasurementSeries` to a `MeasuredSettlementSeries`.
+Based on the start date the displacements are calculated.
+
+For more information on the :func:`baec.measurements.measured_settlement_series.MeasuredSettlementSeries`
+class go the the reference.
+
+
+.. ipython:: python
+
+    import datetime
+
+    from baec.measurements.measured_settlement_series import MeasuredSettlementSeries
+
+    # Create series from measurements
+    series = MeasuredSettlementSeries(
+        measurements,
+        start_date_time=measurements.measurements[0].date_time
+        + datetime.timedelta(days=200),
+    )
+
+    # plot displacements
+    @savefig displacements.png
+    series.plot_xy_displacements_plan_view()