Update dev version documentation

dev/_sources/user/setup.rst.txt

@@ -11,7 +11,24 @@ company name.
 You can specify the configuration in two ways. One is to create a geolib.env
 file in your working directory. The second is to specify environment variables.
 
-The *geolib.env* file is a simple text file, which can contain any number of parameters, for example::
+The *geolib.env* file is a simple text file, which can contain any number of parameters, see the two methods below
+to see how you can use this file to configure the path to the console applications.
+
+Setting the console paths per application
+-----------------------------------------
+
+In the *geolib.env* file, you can set the paths to the console applications, for example::
+
+    DSTABILITY_CONSOLE_PATH="C:\\Program Files (x86)\\Deltares\\D-GEO Suite\\D-Stability 2023.01\\bin\\D-Stability Console.exe"
+    DGEOFLOW_CONSOLE_PATH="C:\\Program Files\\Deltares\\D-GEO Suite\\D-Geo Flow 2023.01\\bin\\DGeoFlow Console.exe"
+    DSHEETPILING_CONSOLE_PATH="C:\\Program Files (x86)\\Deltares\\D-Sheet Piling 23.1.1\\DSheetPiling.exe"
+    DFOUNDATIONS_CONSOLE_PATH="C:\\Program Files (x86)\\Deltares\\D-Foundations 23.1.1\\DFoundations.exe"
+    DSETTLEMENT_CONSOLE_PATH="C:\\Program Files (x86)\\Deltares\\D-Settlement 23.1.1\\DSettlement.exe"
+
+Settings the console path using the common CONSOLE_FOLDER variable
+------------------------------------------------------------------
+
+In the *geolib.env* file, you can set the CONSOLE_FOLDER variable to a folder that should contain all console applications in a single location, for example::
 
     CONSOLE_FOLDER="C:\\Users\\You\\Documents\\GEOLibConsoles"  # path has to exist!
 
@@ -29,6 +46,9 @@ otherwise GEOLib will not start. The executables are expected in the following l
 It can also be set by a **CONSOLE_FOLDER** environment variable. The environment variable will
 overrule the .env file, which in its turn, overrides the defaults set in Python.
 
+Default settings
+----------------
+
 The defaults are as follows::
 
     company: str = ""
@@ -57,16 +77,15 @@ Dynamic settings
 ----------------
 
 If you don't wish to use *geolib.env* files or wish to override them, you can change the final settings
-in Python itself, using the *meta* attribute of a model. For example, to override the *console_folder*::
+in Python itself, using the *meta* methods on a model. Note that changing the properties for one model changes the global settings, so it applies to all instances of a model.
+For example, to override the *console_folder*::
 
     >>> import geolib as gl
     >>> from pathlib import Path
     >>> dm = gl.models.DSettlementModel()
-    >>> dm.meta
-    MetaData(company='Deltares', analyst='', startdate=datetime.datetime(2020, 10, 7, 15, 44, 9, 174187), project='', remarks='Created by GEOLib 0.1.2', endpoint=AnyHttpUrl('http://localhost:8000/', scheme='http', host='localhost', host_type='int_domain', port='8000', path='/'), gl_username='test', gl_password='test', console_folder=PosixPath('tests'))
-    >>> dm.meta.console_folder
-    PosixPath('tests')
-    >>> dm.meta.console_folder = Path("other_location")  # has to exist!
+    >>> dm.get_meta_property("company")
+    Deltares
+    >>> dm.set_meta_property("console_folder", Path("other_location"))
 
 Logging
 -------
@@ -108,7 +127,7 @@ At the moment that version number is:
 * D-Foundations **23.1**
 * D-SheetPiling **23.1**
 * D-Stability **2023.01**
-* D-Geo flow **2022.01**
+* D-Geo Flow **2023.01**
 
 Loading files generated by either older or newer versions isn't guaranteed to work and will likely result in an error message such as ValidationError(extra fields not permitted).
 You could disable this by changing the extra_fields setting described above, but we don't support this.

dev/dev/_autosummary/geolib.models.base_model.html

@@ -95,15 +95,20 @@
 <dd></dd></dl>
 
 <dl class="py property">
-<dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.console_path">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.base_model.BaseModel.console_path" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.custom_console_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">custom_console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#geolib.models.base_model.BaseModel.custom_console_path" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.datastructure">
 <span class="sig-name descname"><span class="pre">datastructure</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><a class="reference internal" href="geolib.models.base_model_structure.html#geolib.models.base_model_structure.BaseModelStructure" title="geolib.models.base_model_structure.BaseModelStructure"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModelStructure</span></code></a><span class="pre">]</span></em><a class="headerlink" href="#geolib.models.base_model.BaseModel.datastructure" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.default_console_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.base_model.BaseModel.default_console_path" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.execute">
 <span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout_in_seconds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">600</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geolib.models.base_model.BaseModel.execute" title="Link to this definition">¶</a></dt>
@@ -150,6 +155,20 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.get_meta_property">
+<span class="sig-name descname"><span class="pre">get_meta_property</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geolib.models.base_model.BaseModel.get_meta_property" title="Link to this definition">¶</a></dt>
+<dd><p>Get a metadata property from the input file.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>key</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – </p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.input">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">input</span></span><a class="headerlink" href="#geolib.models.base_model.BaseModel.input" title="Link to this definition">¶</a></dt>
@@ -211,6 +230,23 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="geolib.models.base_model.BaseModel.set_meta_property">
+<span class="sig-name descname"><span class="pre">set_meta_property</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geolib.models.base_model.BaseModel.set_meta_property" title="Link to this definition">¶</a></dt>
+<dd><p>Set a metadata property from the input file.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>key</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – </p></li>
+<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">

dev/dev/_autosummary/geolib.models.dfoundations.dfoundations_model.html

@@ -239,20 +239,25 @@
 <dd></dd></dl>
 
 <dl class="py property">
-<dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.console_path">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.console_path" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.cpts">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cpts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="geolib.models.dfoundations.internal.html#geolib.models.dfoundations.internal.CPTList" title="geolib.models.dfoundations.internal.CPTList"><span class="pre">CPTList</span></a></em><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.cpts" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py property">
-<dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.cpts">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cpts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="geolib.models.dfoundations.internal.html#geolib.models.dfoundations.internal.CPTList" title="geolib.models.dfoundations.internal.CPTList"><span class="pre">CPTList</span></a></em><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.cpts" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.custom_console_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">custom_console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.custom_console_path" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.datastructure">
 <span class="sig-name descname"><span class="pre">datastructure</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code><span class="pre">[</span><a class="reference internal" href="geolib.models.dfoundations.internal.html#geolib.models.dfoundations.internal.DFoundationsDumpStructure" title="geolib.models.dfoundations.internal.DFoundationsDumpStructure"><code class="xref py py-class docutils literal notranslate"><span class="pre">DFoundationsDumpStructure</span></code></a><span class="pre">,</span> <a class="reference internal" href="geolib.models.dfoundations.internal.html#geolib.models.dfoundations.internal.DFoundationsStructure" title="geolib.models.dfoundations.internal.DFoundationsStructure"><code class="xref py py-class docutils literal notranslate"><span class="pre">DFoundationsStructure</span></code></a><span class="pre">]</span></em><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.datastructure" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.default_console_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.default_console_path" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="geolib.models.dfoundations.dfoundations_model.DFoundationsModel.input">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">input</span></span><a class="headerlink" href="#geolib.models.dfoundations.dfoundations_model.DFoundationsModel.input" title="Link to this definition">¶</a></dt>

dev/dev/_autosummary/geolib.models.dgeoflow.dgeoflow_model.html

@@ -224,11 +224,6 @@
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console_flags_post</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.console_flags_post" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py property">
-<dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.console_path">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.console_path" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
 <dl class="py attribute">
 <dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.current_calculation_index">
 <span class="sig-name descname"><span class="pre">current_calculation_index</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.current_calculation_index" title="Link to this definition">¶</a></dt>
@@ -254,11 +249,21 @@
 <span class="sig-name descname"><span class="pre">current_stage_index</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.current_stage_index" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.custom_console_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">custom_console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.custom_console_path" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.datastructure">
 <span class="sig-name descname"><span class="pre">datastructure</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="geolib.models.dgeoflow.internal.html#geolib.models.dgeoflow.internal.DGeoFlowStructure" title="geolib.models.dgeoflow.internal.DGeoFlowStructure"><code class="xref py py-class docutils literal notranslate"><span class="pre">DGeoFlowStructure</span></code></a></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.datastructure" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.default_console_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_console_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.default_console_path" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.edit_soil">
 <span class="sig-name descname"><span class="pre">edit_soil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.edit_soil" title="Link to this definition">¶</a></dt>