diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index b702f96..cf4a990 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/tree/reference.doctree b/.doctrees/tree/reference.doctree index dfd4789..ef42508 100644 Binary files a/.doctrees/tree/reference.doctree and b/.doctrees/tree/reference.doctree differ diff --git a/_modules/pyvibracore/api.html b/_modules/pyvibracore/api.html index 4a22b9c..a58b272 100644 --- a/_modules/pyvibracore/api.html +++ b/_modules/pyvibracore/api.html @@ -89,17 +89,34 @@

Source code for pyvibracore.api

     while status in ["PENDING", "STARTED", "RETRY"]:
         sleep_time = min(sleep_time * 2, 10)
         sleep(sleep_time)
-        response = client.call_endpoint(
+        status_response = client.call_endpoint(
             "VibraCore", "/get-task-status", schema=ticket.json(), return_response=True
         )
-        if response.status_code != 200:
-            raise RuntimeError(rf"{response.text}")
-        status = response.json()["state"]
 
+        # Check if the status response is OK
+        if status_response.status_code != 200:
+            raise RuntimeError(rf"{status_response.text}")
+
+        status = status_response.json()["state"]
+
+    # If the status is FAILURE, raise an error
     if status == "FAILURE":
-        raise RuntimeError(
-            f'{response.json().get("msg")}\n{response.json().get("traceback")}'
-        )
+        # Get the task-status failure message
+        failure_message = status_response.json()["msg"]
+
+        # Try to get the task-result failure message
+        try:
+            result_response = client.call_endpoint(
+                "VibraCore",
+                "/get-task-results",
+                schema=ticket.json(),
+                return_response=True,
+            )
+            failure_message = result_response.text
+
+        # Raise the obtained failure message
+        finally:
+            raise RuntimeError(failure_message)
 
 
 
[docs]def get_impact_force_report(client: NucleiClient, payload: dict) -> bytes:
diff --git a/_modules/pyvibracore/input/impact_force_properties.html b/_modules/pyvibracore/input/impact_force_properties.html
index 456c1f6..34a0447 100644
--- a/_modules/pyvibracore/input/impact_force_properties.html
+++ b/_modules/pyvibracore/input/impact_force_properties.html
@@ -73,7 +73,9 @@
            

              
   
Source code for pyvibracore.input.impact_force_properties
-from copy import deepcopy
+from __future__ import annotations
+
+from copy import deepcopy
 from dataclasses import dataclass
 from typing import Dict, List, Literal
 
@@ -163,6 +165,7 @@ 
Source code for pyvibracore.input.impact_force_properties
friction_strategy: Literal["CPTFrictionStrategy", "SlipFrictionStrategy"],
     drive_strategy: Literal["vibrate", "push"],
     installation_level_offset: float,
+    groundwater_level_offset: None | float = None,
     zeta: float = 0.6,
 ) -> dict:
     """
@@ -227,6 +230,9 @@ 
Source code for pyvibracore.input.impact_force_properties
        The push strategy calculates the impact force based on a push installation method.
     installation_level_offset: float
         Installation level of the sheet pile [m w.r.t REF]
+    groundwater_level_offset: float, optional
+        Groundwater level for all cpts. if None groundwater level of cpt is used. if no
+        groundwater level is set in the cpt we will take one meter below surface level [m w.r.t REF]
     zeta: float = 0.6
         verknedingsfactor [-], used in the push drive strategy based on CUR 166 6th edition.
 
@@ -252,9 +258,9 @@ 
Source code for pyvibracore.input.impact_force_properties
"y": cpt.delivered_location.y,
                 },
                 "customInterval": CustomInterval,
-                "groundwaterLevelOffset": cpt.groundwater_level_offset
-                if cpt.groundwater_level_offset
-                else cpt.delivered_vertical_position_offset - 1,
+                "groundwaterLevelOffset": groundwater_level_offset
+                or cpt.groundwater_level_offset
+                or cpt.delivered_vertical_position_offset - 1,
                 "layerTable": {
                     "gamma_sat": classify_tables[cpt.alias].get("gamma_sat"),
                     "gamma_unsat": classify_tables[cpt.alias].get("gamma_unsat"),
diff --git a/searchindex.js b/searchindex.js
index d6e4005..d4af52e 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["index", "tree/getting_started", "tree/reference"], "filenames": ["index.rst", "tree/getting_started.rst", "tree/reference.rst"], "titles": ["Welcome to py-VibraCore documentation!", "Installing py-vibracore", "Reference"], "terms": {"The": [0, 2], "librari": [0, 1], "i": [0, 1, 2], "creat": [0, 2], "cem": 0, "bv": 0, "public": 0, "python": [0, 1], "wrapper": [0, 2], "around": [0, 2], "web": 0, "api": [0, 1], "index": [0, 1], "instal": [0, 2], "risk": 0, "damag": 0, "dure": 0, "construct": 0, "sbr": 0, "A": 0, "impact": 0, "forc": 0, "determin": 0, "cur166": 0, "guid": 0, "usag": 0, "payload": [0, 2], "call": [0, 2], "endpoint": [0, 2], "refer": [0, 1], "applic": [0, 1], "program": [0, 1], "interfac": [0, 1], "sound": 0, "To": [1, 2], "pyvibracor": [1, 2], "we": 1, "strongli": 1, "recommend": 1, "us": [1, 2], "packag": 1, "pypi": 1, "you": 1, "can": [1, 2], "pip": 1, "notebook": 1, "variant": 1, "which": 1, "includ": [1, 2], "addit": [1, 2], "depend": 1, "therebi": 1, "enabl": 1, "function": 1, "an": 1, "servic": 1, "base": [1, 2], "autom": 1, "manag": 1, "build": [1, 2], "vibrat": [1, 2], "work": 1, "sheet": [1, 2], "pile": [1, 2], "driven": 1, "attribut": 1, "nearbi": 1, "failur": 1, "veloc": 1, "calcul": [1, 2], "accord": 1, "If": [1, 2], "check": 1, "fail": 1, "ha": [1, 2], "unaccept": 1, "being": 1, "properti": 1, "prepal": [1, 2], "data": [1, 2], "sourc": [1, 2], "soil": [1, 2], "jupyt": 1, "through": 1, "thi": [1, 2], "step": 1, "found": [1, 2], "nbxxxxx_sbra": 1, "ipynb": 1, "profil": 1, "gef": 1, "file": 1, "maximum": 1, "cur": [1, 2], "166": [1, 2], "3rd": [1, 2], "edit": [1, 2], "predict": [1, 2], "cone": [1, 2], "penetr": 1, "test": 1, "cpt": [1, 2], "classif": 1, "method": [1, 2], "nbxxxxx_impact_forc": 1, "get": [1, 2], "start": 1, "easi": 1, "done": 1, "import": 1, "In": 1, "1": [1, 2], "ani": [1, 2], "equival": 1, "statement": 1, "re": 1, "so": 1, "comfort": 1, "your": 1, "own": 1, "schema": 1, "": [1, 2], "sdk": 1, "provid": [1, 2], "usefulli": 1, "dictionari": [1, 2], "content": [1, 2], "find": [1, 2], "input": 1, "pleas": 1, "read": 1, "page": [1, 2], "more": [1, 2], "inform": [1, 2], "perpal": 1, "from": [1, 2], "vibration_properti": [1, 2], "create_cur166_payload": [1, 2], "get_buildings_geodatafram": [1, 2], "west": [1, 2], "south": [1, 2], "east": [1, 2], "north": [1, 2], "locat": [1, 2], "point": [1, 2], "x": [1, 2], "y": [1, 2], "500": 1, "With": 1, "nuclei": [1, 2], "client": [1, 2], "possibl": 1, "request": [1, 2], "assist": 1, "process": 1, "nucleicli": [1, 2], "respons": [1, 2], "get_cur166_calcul": [1, 2], "multi_vibration_payload": [1, 2], "help": 1, "user": 1, "gener": 1, "tabl": [1, 2], "plot": [1, 2], "class": [1, 2], "store": [1, 2], "structur": [1, 2], "wai": 1, "vibration_result": [1, 2], "vibrationresult": [1, 2], "from_api_respons": [1, 2], "get_impact_force_report": 2, "vibracor": 2, "report": 2, "paramet": 2, "object": 2, "http": 2, "github": 2, "com": 2, "cemsbv": 2, "dict": 2, "create_multi_cpt_impact_force_report_payload": 2, "return": 2, "type": 2, "byte": 2, "get_impact_force_calcul": 2, "multi": 2, "create_multi_cpt_impact_force_payload": 2, "get_prepal_calcul": 2, "valid": 2, "create_prepal_payload": 2, "get_cur166_report": 2, "create_vibration_report_payload": 2, "get_prepal_report": 2, "impact_force_properti": 2, "cptdata_object": 2, "classify_t": 2, "vibration_sourc": 2, "friction_strategi": 2, "drive_strategi": 2, "installation_level_offset": 2, "zeta": 2, "0": 2, "6": 2, "pass": 2, "directli": 2, "call_endpoint": 2, "list": 2, "cptdata": 2, "pygef": 2, "str": 2, "map": 2, "alia": 2, "valu": 2, "cptcore": 2, "classifi": 2, "contain": 2, "follow": 2, "kei": 2, "geotechnicalsoilnam": 2, "sequenc": 2, "geotechn": 2, "name": 2, "relat": 2, "iso": 2, "lowerboundari": 2, "float": 2, "lower": 2, "boundari": 2, "layer": 2, "m": 2, "upperboundari": 2, "upper": 2, "color": 2, "hex": 2, "code": 2, "maincompon": 2, "liter": 2, "rock": 2, "gravel": 2, "sand": 2, "silt": 2, "clai": 2, "peat": 2, "main": 2, "compon": 2, "cohes": 2, "kpa": 2, "gamma_sat": 2, "satur": 2, "unit": 2, "weight": 2, "kn": 2, "3": 2, "gamma_unsat": 2, "unsatur": 2, "phi": 2, "degre": 2, "undrainedshearstrength": 2, "undrain": 2, "shear": 2, "strength": 2, "vibrationsourc": 2, "cptfrictionstrategi": 2, "slipfrictionstrategi": 2, "defin": 2, "strategi": 2, "how": 2, "comput": 2, "sleev": 2, "friction": 2, "take": 2, "note": 2, "onli": 2, "when": 2, "within": 2, "slip": 2, "gamma": 2, "must": 2, "push": 2, "level": 2, "w": 2, "r": 2, "t": 2, "ref": 2, "verknedingsfactor": 2, "drive": 2, "6th": 2, "multi_cpt_payload": 2, "project_nam": 2, "project_id": 2, "author": 2, "project": 2, "identifi": 2, "create_single_cpt_impact_force_payload": 2, "singl": 2, "impact_force_result": 2, "multicalculationdata": 2, "gdf": 2, "dataclass": 2, "hold": 2, "gpd": 2, "geodatafram": 2, "__init__": 2, "classmethod": 2, "response_dict": 2, "figsiz": 2, "10": 2, "12": 2, "set": 2, "none": 2, "kwarg": 2, "tupl": 2, "size": 2, "activ": 2, "figur": 2, "plt": 2, "argument": 2, "default": 2, "ar": 2, "hue": 2, "max": 2, "titl": 2, "maximal": 2, "slagkracht": 2, "xlabel": 2, "co\u00f6rdinaat": 2, "ylabel": 2, "all": 2, "keyword": 2, "pyplot": 2, "subplot": 2, "matplotlib": 2, "fig": 2, "singlecalculationdata": 2, "installationlevel": 2, "maximumforc": 2, "pointforc": 2, "impactforcet": 2, "total": 2, "resist": 2, "categori": 2, "two": 2, "monument": 2, "fals": 2, "structural_condit": 2, "normal": 2, "vibration_sensit": 2, "thick": 2, "8": 2, "foundation_el": 2, "shallow": 2, "foundat": 2, "material_floor": 2, "concret": 2, "featur": 2, "bag": 2, "pand": 2, "pages": 2, "1000": 2, "coordin": 2, "rd": 2, "new": 2, "epsg": 2, "28992": 2, "one": 2, "bool": 2, "statu": 2, "sensit": 2, "2": 2, "chapter": 2, "5": 2, "settlement": 2, "timber": 2, "steel": 2, "19": 2, "wood": 2, "20": 2, "ligplaat": 2, "verblijfsobject": 2, "woonplaat": 2, "standplaat": 2, "item": 2, "see": 2, "www": 2, "nationaalgeoregist": 2, "nl": 2, "geonetwork": 2, "srv": 2, "dut": 2, "catalog": 2, "search": 2, "metadata": 2, "1c0dcc64": 2, "91aa": 2, "4d44": 2, "a9e3": 2, "54355556f5e7": 2, "50": 2, "100": 2, "per": 2, "get_normative_build": 2, "closest": 2, "polygon": 2, "linestr": 2, "geometri": 2, "create_single_payload": 2, "vibration_payload": 2, "pile_shap": 2, "pile_s": 2, "cone_resist": 2, "reduct": 2, "unit_weight": 2, "elastic_modulus_factor": 2, "15": 2, "poisson_ratio": 2, "frequenc": 2, "vibration_typ": 2, "continu": 2, "frequency_vibration_sensit": 2, "40": 2, "measurement_typ": 2, "extens": 2, "hysteretic_damping_barkan": 2, "05": 2, "teh": 2, "have": 2, "column": 2, "buildingdepth": 2, "minimum": 2, "depth": 2, "buildingdepthvibrationsensit": 2, "structuralcondit": 2, "vibrationsensit": 2, "poisson": 2, "ratio": 2, "elast": 2, "modulu": 2, "factor": 2, "volum": 2, "mpa": 2, "squar": 2, "round": 2, "shape": 2, "domin": 2, "hz": 2, "short": 2, "term": 2, "repeat": 2, "4": 2, "indic": 2, "limit": 2, "measur": 2, "9": 2, "hysteret": 2, "damp": 2, "barkan": 2, "rais": 2, "keyerror": 2, "miss": 2, "installation_typ": 2, "building_part": 2, "floor": 2, "safety_factor": 2, "vibration_direct": 2, "vertic": 2, "30": 2, "reference_loc": 2, "amsterdam": 2, "methode_safety_factor": 2, "exact": 2, "foundationel": 2, "materi": 2, "21": 2, "wall": 2, "22": 2, "horizont": 2, "high": 2, "maasvlakt": 2, "rotterdam": 2, "groningen": 2, "den": 2, "haag": 2, "tiel": 2, "eindhoven": 2, "1997": 2, "16": 2, "17": 2, "safeti": 2, "info": 2, "about": 2, "here": 2, "issuu": 2, "uitgeverijeducom": 2, "doc": 2, "geo_okt2014_totaal_v4_klein": 2, "36": 2, "valueerror": 2, "No": 2, "source_loc": 2, "legend": 2, "label": 2, "trillingsbron": 2, "black": 2, "insufficient_cat1": 2, "voldoet": 2, "niet": 2, "cat": 2, "orang": 2, "insufficient_cat2": 2, "red": 2, "suffici": 2, "green": 2, "map_payload": 2, "sensitive_cat1": 2, "monumenta": 2, "gevoelig": 2, "blue": 2, "sensitive_cat2": 2, "cyan": 2, "normal_cat1": 2, "normaal": 2, "normal_cat2": 2, "oliv": 2, "plot_reduct": 2, "flag": 2, "sound_result": 2, "follw": 2, "woonfuncti": 2, "gezondheidsfuncti": 2, "onderwijsfuncti": 2, "map_sound": 2, "building_nam": 2, "power": 2, "k2": 2, "period": 2, "db": 2, "correct": 2, "oper": 2, "hour": 2, "80": 2, "dagen": 2, "darkr": 2, "75": 2, "70": 2, "65": 2, "darkgreen": 2, "60": 2}, "objects": {"pyvibracore.api": [[2, 0, 1, "", "get_cur166_calculation"], [2, 0, 1, "", "get_cur166_report"], [2, 0, 1, "", "get_impact_force_calculation"], [2, 0, 1, "", "get_impact_force_report"], [2, 0, 1, "", "get_prepal_calculation"], [2, 0, 1, "", "get_prepal_report"]], "pyvibracore.input.impact_force_properties": [[2, 0, 1, "", "create_multi_cpt_impact_force_payload"], [2, 0, 1, "", "create_multi_cpt_impact_force_report_payload"], [2, 0, 1, "", "create_single_cpt_impact_force_payload"]], "pyvibracore.input.vibration_properties": [[2, 0, 1, "", "create_cur166_payload"], [2, 0, 1, "", "create_prepal_payload"], [2, 0, 1, "", "create_single_payload"], [2, 0, 1, "", "create_vibration_report_payload"], [2, 0, 1, "", "get_buildings_geodataframe"], [2, 0, 1, "", "get_normative_building"]], "pyvibracore.results.impact_force_result": [[2, 1, 1, "", "MultiCalculationData"], [2, 1, 1, "", "SingleCalculationData"]], "pyvibracore.results.impact_force_result.MultiCalculationData": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "from_api_response"], [2, 3, 1, "", "gdf"], [2, 2, 1, "", "plot"]], "pyvibracore.results.impact_force_result.SingleCalculationData": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "from_api_response"], [2, 2, 1, "", "plot"]], "pyvibracore.results.sound_result": [[2, 0, 1, "", "get_normative_building"], [2, 0, 1, "", "map_sound"]], "pyvibracore.results.vibration_result": [[2, 1, 1, "", "VibrationResults"], [2, 0, 1, "", "map_payload"], [2, 0, 1, "", "plot_reduction"]], "pyvibracore.results.vibration_result.VibrationResults": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "from_api_response"], [2, 3, 1, "", "gdf"], [2, 2, 1, "", "map"]]}, "objtypes": {"0": "py:function", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"welcom": 0, "py": [0, 1], "vibracor": [0, 1], "document": 0, "indic": 0, "tabl": 0, "content": 0, "instal": 1, "risk": 1, "damag": 1, "dure": 1, "construct": 1, "sbr": [1, 2], "A": [1, 2], "impact": [1, 2], "forc": [1, 2], "determin": 1, "cur166": [1, 2], "guid": 1, "usag": 1, "creat": 1, "payload": 1, "call": 1, "endpoint": 1, "result": [1, 2], "refer": 2, "applic": 2, "program": 2, "interfac": 2, "api": 2, "input": 2, "attribut": 2, "perpal": 2, "sound": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"Welcome to py-VibraCore documentation!": [[0, "welcome-to-py-vibracore-documentation"]], "Indices and tables": [[0, "indices-and-tables"]], "Contents:": [[0, null]], "Installing py-vibracore": [[1, "installing-py-vibracore"]], "Risk of damage during construction [SBR-A]": [[1, "risk-of-damage-during-construction-sbr-a"]], "Impact force determination [CUR166]": [[1, "impact-force-determination-cur166"]], "Guided usage": [[1, "guided-usage"]], "Create payload": [[1, "create-payload"]], "Call endpoint": [[1, "call-endpoint"]], "Create results": [[1, "create-results"]], "Reference": [[2, "reference"]], "Application programming interface (API)": [[2, "application-programming-interface-api"]], "Impact Force": [[2, "impact-force"]], "Input": [[2, "input"], [2, "sbrainput"]], "Result": [[2, "result"], [2, "sbraresult"]], "Attributes:": [[2, "attributes"]], "SBR-A": [[2, "sbr-a"]], "PerPal": [[2, "perpal"]], "CUR166": [[2, "cur166"]], "Sound": [[2, "sound"]]}, "indexentries": {"multicalculationdata (class in pyvibracore.results.impact_force_result)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData"]], "singlecalculationdata (class in pyvibracore.results.impact_force_result)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData"]], "vibrationresults (class in pyvibracore.results.vibration_result)": [[2, "pyvibracore.results.vibration_result.VibrationResults"]], "__init__() (pyvibracore.results.impact_force_result.multicalculationdata method)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.__init__"]], "__init__() (pyvibracore.results.impact_force_result.singlecalculationdata method)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData.__init__"]], "__init__() (pyvibracore.results.vibration_result.vibrationresults method)": [[2, "pyvibracore.results.vibration_result.VibrationResults.__init__"]], "create_cur166_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_cur166_payload"]], "create_multi_cpt_impact_force_payload() (in module pyvibracore.input.impact_force_properties)": [[2, "pyvibracore.input.impact_force_properties.create_multi_cpt_impact_force_payload"]], "create_multi_cpt_impact_force_report_payload() (in module pyvibracore.input.impact_force_properties)": [[2, "pyvibracore.input.impact_force_properties.create_multi_cpt_impact_force_report_payload"]], "create_prepal_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_prepal_payload"]], "create_single_cpt_impact_force_payload() (in module pyvibracore.input.impact_force_properties)": [[2, "pyvibracore.input.impact_force_properties.create_single_cpt_impact_force_payload"]], "create_single_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_single_payload"]], "create_vibration_report_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_vibration_report_payload"]], "from_api_response() (pyvibracore.results.impact_force_result.multicalculationdata class method)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.from_api_response"]], "from_api_response() (pyvibracore.results.impact_force_result.singlecalculationdata class method)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData.from_api_response"]], "from_api_response() (pyvibracore.results.vibration_result.vibrationresults class method)": [[2, "pyvibracore.results.vibration_result.VibrationResults.from_api_response"]], "gdf (pyvibracore.results.impact_force_result.multicalculationdata attribute)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.gdf"]], "gdf (pyvibracore.results.vibration_result.vibrationresults attribute)": [[2, "pyvibracore.results.vibration_result.VibrationResults.gdf"]], "get_buildings_geodataframe() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.get_buildings_geodataframe"]], "get_cur166_calculation() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_cur166_calculation"]], "get_cur166_report() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_cur166_report"]], "get_impact_force_calculation() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_impact_force_calculation"]], "get_impact_force_report() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_impact_force_report"]], "get_normative_building() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.get_normative_building"]], "get_normative_building() (in module pyvibracore.results.sound_result)": [[2, "pyvibracore.results.sound_result.get_normative_building"]], "get_prepal_calculation() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_prepal_calculation"]], "get_prepal_report() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_prepal_report"]], "map() (pyvibracore.results.vibration_result.vibrationresults method)": [[2, "pyvibracore.results.vibration_result.VibrationResults.map"]], "map_payload() (in module pyvibracore.results.vibration_result)": [[2, "pyvibracore.results.vibration_result.map_payload"]], "map_sound() (in module pyvibracore.results.sound_result)": [[2, "pyvibracore.results.sound_result.map_sound"]], "plot() (pyvibracore.results.impact_force_result.multicalculationdata method)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.plot"]], "plot() (pyvibracore.results.impact_force_result.singlecalculationdata method)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData.plot"]], "plot_reduction() (in module pyvibracore.results.vibration_result)": [[2, "pyvibracore.results.vibration_result.plot_reduction"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["index", "tree/getting_started", "tree/reference"], "filenames": ["index.rst", "tree/getting_started.rst", "tree/reference.rst"], "titles": ["Welcome to py-VibraCore documentation!", "Installing py-vibracore", "Reference"], "terms": {"The": [0, 2], "librari": [0, 1], "i": [0, 1, 2], "creat": [0, 2], "cem": 0, "bv": 0, "public": 0, "python": [0, 1], "wrapper": [0, 2], "around": [0, 2], "web": 0, "api": [0, 1], "index": [0, 1], "instal": [0, 2], "risk": 0, "damag": 0, "dure": 0, "construct": 0, "sbr": 0, "A": 0, "impact": 0, "forc": 0, "determin": 0, "cur166": 0, "guid": 0, "usag": 0, "payload": [0, 2], "call": [0, 2], "endpoint": [0, 2], "refer": [0, 1], "applic": [0, 1], "program": [0, 1], "interfac": [0, 1], "sound": 0, "To": [1, 2], "pyvibracor": [1, 2], "we": [1, 2], "strongli": 1, "recommend": 1, "us": [1, 2], "packag": 1, "pypi": 1, "you": 1, "can": [1, 2], "pip": 1, "notebook": 1, "variant": 1, "which": 1, "includ": [1, 2], "addit": [1, 2], "depend": 1, "therebi": 1, "enabl": 1, "function": 1, "an": 1, "servic": 1, "base": [1, 2], "autom": 1, "manag": 1, "build": [1, 2], "vibrat": [1, 2], "work": 1, "sheet": [1, 2], "pile": [1, 2], "driven": 1, "attribut": 1, "nearbi": 1, "failur": 1, "veloc": 1, "calcul": [1, 2], "accord": 1, "If": [1, 2], "check": 1, "fail": 1, "ha": [1, 2], "unaccept": 1, "being": 1, "properti": 1, "prepal": [1, 2], "data": [1, 2], "sourc": [1, 2], "soil": [1, 2], "jupyt": 1, "through": 1, "thi": [1, 2], "step": 1, "found": [1, 2], "nbxxxxx_sbra": 1, "ipynb": 1, "profil": 1, "gef": 1, "file": 1, "maximum": 1, "cur": [1, 2], "166": [1, 2], "3rd": [1, 2], "edit": [1, 2], "predict": [1, 2], "cone": [1, 2], "penetr": 1, "test": 1, "cpt": [1, 2], "classif": 1, "method": [1, 2], "nbxxxxx_impact_forc": 1, "get": [1, 2], "start": 1, "easi": 1, "done": 1, "import": 1, "In": 1, "1": [1, 2], "ani": [1, 2], "equival": 1, "statement": 1, "re": 1, "so": 1, "comfort": 1, "your": 1, "own": 1, "schema": 1, "": [1, 2], "sdk": 1, "provid": [1, 2], "usefulli": 1, "dictionari": [1, 2], "content": [1, 2], "find": [1, 2], "input": 1, "pleas": 1, "read": 1, "page": [1, 2], "more": [1, 2], "inform": [1, 2], "perpal": 1, "from": [1, 2], "vibration_properti": [1, 2], "create_cur166_payload": [1, 2], "get_buildings_geodatafram": [1, 2], "west": [1, 2], "south": [1, 2], "east": [1, 2], "north": [1, 2], "locat": [1, 2], "point": [1, 2], "x": [1, 2], "y": [1, 2], "500": 1, "With": 1, "nuclei": [1, 2], "client": [1, 2], "possibl": 1, "request": [1, 2], "assist": 1, "process": 1, "nucleicli": [1, 2], "respons": [1, 2], "get_cur166_calcul": [1, 2], "multi_vibration_payload": [1, 2], "help": 1, "user": 1, "gener": 1, "tabl": [1, 2], "plot": [1, 2], "class": [1, 2], "store": [1, 2], "structur": [1, 2], "wai": 1, "vibration_result": [1, 2], "vibrationresult": [1, 2], "from_api_respons": [1, 2], "get_impact_force_report": 2, "vibracor": 2, "report": 2, "paramet": 2, "object": 2, "http": 2, "github": 2, "com": 2, "cemsbv": 2, "dict": 2, "create_multi_cpt_impact_force_report_payload": 2, "return": 2, "type": 2, "byte": 2, "get_impact_force_calcul": 2, "multi": 2, "create_multi_cpt_impact_force_payload": 2, "get_prepal_calcul": 2, "valid": 2, "create_prepal_payload": 2, "get_cur166_report": 2, "create_vibration_report_payload": 2, "get_prepal_report": 2, "impact_force_properti": 2, "cptdata_object": 2, "classify_t": 2, "vibration_sourc": 2, "friction_strategi": 2, "drive_strategi": 2, "installation_level_offset": 2, "groundwater_level_offset": 2, "none": 2, "zeta": 2, "0": 2, "6": 2, "pass": 2, "directli": 2, "call_endpoint": 2, "list": 2, "cptdata": 2, "pygef": 2, "str": 2, "map": 2, "alia": 2, "valu": 2, "cptcore": 2, "classifi": 2, "contain": 2, "follow": 2, "kei": 2, "geotechnicalsoilnam": 2, "sequenc": 2, "geotechn": 2, "name": 2, "relat": 2, "iso": 2, "lowerboundari": 2, "float": 2, "lower": 2, "boundari": 2, "layer": 2, "m": 2, "upperboundari": 2, "upper": 2, "color": 2, "hex": 2, "code": 2, "maincompon": 2, "liter": 2, "rock": 2, "gravel": 2, "sand": 2, "silt": 2, "clai": 2, "peat": 2, "main": 2, "compon": 2, "cohes": 2, "kpa": 2, "gamma_sat": 2, "satur": 2, "unit": 2, "weight": 2, "kn": 2, "3": 2, "gamma_unsat": 2, "unsatur": 2, "phi": 2, "degre": 2, "undrainedshearstrength": 2, "undrain": 2, "shear": 2, "strength": 2, "vibrationsourc": 2, "cptfrictionstrategi": 2, "slipfrictionstrategi": 2, "defin": 2, "strategi": 2, "how": 2, "comput": 2, "sleev": 2, "friction": 2, "take": 2, "note": 2, "onli": 2, "when": 2, "within": 2, "slip": 2, "gamma": 2, "must": 2, "push": 2, "level": 2, "w": 2, "r": 2, "t": 2, "ref": 2, "option": 2, "groundwat": 2, "all": 2, "set": 2, "one": 2, "meter": 2, "below": 2, "surfac": 2, "verknedingsfactor": 2, "drive": 2, "6th": 2, "multi_cpt_payload": 2, "project_nam": 2, "project_id": 2, "author": 2, "project": 2, "identifi": 2, "create_single_cpt_impact_force_payload": 2, "singl": 2, "impact_force_result": 2, "multicalculationdata": 2, "gdf": 2, "dataclass": 2, "hold": 2, "gpd": 2, "geodatafram": 2, "__init__": 2, "classmethod": 2, "response_dict": 2, "figsiz": 2, "10": 2, "12": 2, "kwarg": 2, "tupl": 2, "size": 2, "activ": 2, "figur": 2, "plt": 2, "argument": 2, "default": 2, "ar": 2, "hue": 2, "max": 2, "titl": 2, "maximal": 2, "slagkracht": 2, "xlabel": 2, "co\u00f6rdinaat": 2, "ylabel": 2, "keyword": 2, "pyplot": 2, "subplot": 2, "matplotlib": 2, "fig": 2, "singlecalculationdata": 2, "installationlevel": 2, "maximumforc": 2, "pointforc": 2, "impactforcet": 2, "total": 2, "resist": 2, "categori": 2, "two": 2, "monument": 2, "fals": 2, "structural_condit": 2, "normal": 2, "vibration_sensit": 2, "thick": 2, "8": 2, "foundation_el": 2, "shallow": 2, "foundat": 2, "material_floor": 2, "concret": 2, "featur": 2, "bag": 2, "pand": 2, "pages": 2, "1000": 2, "coordin": 2, "rd": 2, "new": 2, "epsg": 2, "28992": 2, "bool": 2, "statu": 2, "sensit": 2, "2": 2, "chapter": 2, "5": 2, "settlement": 2, "timber": 2, "steel": 2, "19": 2, "wood": 2, "20": 2, "ligplaat": 2, "verblijfsobject": 2, "woonplaat": 2, "standplaat": 2, "item": 2, "see": 2, "www": 2, "nationaalgeoregist": 2, "nl": 2, "geonetwork": 2, "srv": 2, "dut": 2, "catalog": 2, "search": 2, "metadata": 2, "1c0dcc64": 2, "91aa": 2, "4d44": 2, "a9e3": 2, "54355556f5e7": 2, "50": 2, "100": 2, "per": 2, "get_normative_build": 2, "closest": 2, "polygon": 2, "linestr": 2, "geometri": 2, "create_single_payload": 2, "vibration_payload": 2, "pile_shap": 2, "pile_s": 2, "cone_resist": 2, "reduct": 2, "unit_weight": 2, "elastic_modulus_factor": 2, "15": 2, "poisson_ratio": 2, "frequenc": 2, "vibration_typ": 2, "continu": 2, "frequency_vibration_sensit": 2, "40": 2, "measurement_typ": 2, "extens": 2, "hysteretic_damping_barkan": 2, "05": 2, "teh": 2, "have": 2, "column": 2, "buildingdepth": 2, "minimum": 2, "depth": 2, "buildingdepthvibrationsensit": 2, "structuralcondit": 2, "vibrationsensit": 2, "poisson": 2, "ratio": 2, "elast": 2, "modulu": 2, "factor": 2, "volum": 2, "mpa": 2, "squar": 2, "round": 2, "shape": 2, "domin": 2, "hz": 2, "short": 2, "term": 2, "repeat": 2, "4": 2, "indic": 2, "limit": 2, "measur": 2, "9": 2, "hysteret": 2, "damp": 2, "barkan": 2, "rais": 2, "keyerror": 2, "miss": 2, "installation_typ": 2, "building_part": 2, "floor": 2, "safety_factor": 2, "vibration_direct": 2, "vertic": 2, "30": 2, "reference_loc": 2, "amsterdam": 2, "methode_safety_factor": 2, "exact": 2, "foundationel": 2, "materi": 2, "21": 2, "wall": 2, "22": 2, "horizont": 2, "high": 2, "maasvlakt": 2, "rotterdam": 2, "groningen": 2, "den": 2, "haag": 2, "tiel": 2, "eindhoven": 2, "1997": 2, "16": 2, "17": 2, "safeti": 2, "info": 2, "about": 2, "here": 2, "issuu": 2, "uitgeverijeducom": 2, "doc": 2, "geo_okt2014_totaal_v4_klein": 2, "36": 2, "valueerror": 2, "No": 2, "source_loc": 2, "legend": 2, "label": 2, "trillingsbron": 2, "black": 2, "insufficient_cat1": 2, "voldoet": 2, "niet": 2, "cat": 2, "orang": 2, "insufficient_cat2": 2, "red": 2, "suffici": 2, "green": 2, "map_payload": 2, "sensitive_cat1": 2, "monumenta": 2, "gevoelig": 2, "blue": 2, "sensitive_cat2": 2, "cyan": 2, "normal_cat1": 2, "normaal": 2, "normal_cat2": 2, "oliv": 2, "plot_reduct": 2, "flag": 2, "sound_result": 2, "follw": 2, "woonfuncti": 2, "gezondheidsfuncti": 2, "onderwijsfuncti": 2, "map_sound": 2, "building_nam": 2, "power": 2, "k2": 2, "period": 2, "db": 2, "correct": 2, "oper": 2, "hour": 2, "80": 2, "dagen": 2, "darkr": 2, "75": 2, "70": 2, "65": 2, "darkgreen": 2, "60": 2}, "objects": {"pyvibracore.api": [[2, 0, 1, "", "get_cur166_calculation"], [2, 0, 1, "", "get_cur166_report"], [2, 0, 1, "", "get_impact_force_calculation"], [2, 0, 1, "", "get_impact_force_report"], [2, 0, 1, "", "get_prepal_calculation"], [2, 0, 1, "", "get_prepal_report"]], "pyvibracore.input.impact_force_properties": [[2, 0, 1, "", "create_multi_cpt_impact_force_payload"], [2, 0, 1, "", "create_multi_cpt_impact_force_report_payload"], [2, 0, 1, "", "create_single_cpt_impact_force_payload"]], "pyvibracore.input.vibration_properties": [[2, 0, 1, "", "create_cur166_payload"], [2, 0, 1, "", "create_prepal_payload"], [2, 0, 1, "", "create_single_payload"], [2, 0, 1, "", "create_vibration_report_payload"], [2, 0, 1, "", "get_buildings_geodataframe"], [2, 0, 1, "", "get_normative_building"]], "pyvibracore.results.impact_force_result": [[2, 1, 1, "", "MultiCalculationData"], [2, 1, 1, "", "SingleCalculationData"]], "pyvibracore.results.impact_force_result.MultiCalculationData": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "from_api_response"], [2, 3, 1, "", "gdf"], [2, 2, 1, "", "plot"]], "pyvibracore.results.impact_force_result.SingleCalculationData": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "from_api_response"], [2, 2, 1, "", "plot"]], "pyvibracore.results.sound_result": [[2, 0, 1, "", "get_normative_building"], [2, 0, 1, "", "map_sound"]], "pyvibracore.results.vibration_result": [[2, 1, 1, "", "VibrationResults"], [2, 0, 1, "", "map_payload"], [2, 0, 1, "", "plot_reduction"]], "pyvibracore.results.vibration_result.VibrationResults": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "from_api_response"], [2, 3, 1, "", "gdf"], [2, 2, 1, "", "map"]]}, "objtypes": {"0": "py:function", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"welcom": 0, "py": [0, 1], "vibracor": [0, 1], "document": 0, "indic": 0, "tabl": 0, "content": 0, "instal": 1, "risk": 1, "damag": 1, "dure": 1, "construct": 1, "sbr": [1, 2], "A": [1, 2], "impact": [1, 2], "forc": [1, 2], "determin": 1, "cur166": [1, 2], "guid": 1, "usag": 1, "creat": 1, "payload": 1, "call": 1, "endpoint": 1, "result": [1, 2], "refer": 2, "applic": 2, "program": 2, "interfac": 2, "api": 2, "input": 2, "attribut": 2, "perpal": 2, "sound": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"Welcome to py-VibraCore documentation!": [[0, "welcome-to-py-vibracore-documentation"]], "Indices and tables": [[0, "indices-and-tables"]], "Contents:": [[0, null]], "Installing py-vibracore": [[1, "installing-py-vibracore"]], "Risk of damage during construction [SBR-A]": [[1, "risk-of-damage-during-construction-sbr-a"]], "Impact force determination [CUR166]": [[1, "impact-force-determination-cur166"]], "Guided usage": [[1, "guided-usage"]], "Create payload": [[1, "create-payload"]], "Call endpoint": [[1, "call-endpoint"]], "Create results": [[1, "create-results"]], "Reference": [[2, "reference"]], "Application programming interface (API)": [[2, "application-programming-interface-api"]], "Impact Force": [[2, "impact-force"]], "Input": [[2, "input"], [2, "sbrainput"]], "Result": [[2, "result"], [2, "sbraresult"]], "Attributes:": [[2, "attributes"]], "SBR-A": [[2, "sbr-a"]], "PerPal": [[2, "perpal"]], "CUR166": [[2, "cur166"]], "Sound": [[2, "sound"]]}, "indexentries": {"multicalculationdata (class in pyvibracore.results.impact_force_result)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData"]], "singlecalculationdata (class in pyvibracore.results.impact_force_result)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData"]], "vibrationresults (class in pyvibracore.results.vibration_result)": [[2, "pyvibracore.results.vibration_result.VibrationResults"]], "__init__() (pyvibracore.results.impact_force_result.multicalculationdata method)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.__init__"]], "__init__() (pyvibracore.results.impact_force_result.singlecalculationdata method)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData.__init__"]], "__init__() (pyvibracore.results.vibration_result.vibrationresults method)": [[2, "pyvibracore.results.vibration_result.VibrationResults.__init__"]], "create_cur166_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_cur166_payload"]], "create_multi_cpt_impact_force_payload() (in module pyvibracore.input.impact_force_properties)": [[2, "pyvibracore.input.impact_force_properties.create_multi_cpt_impact_force_payload"]], "create_multi_cpt_impact_force_report_payload() (in module pyvibracore.input.impact_force_properties)": [[2, "pyvibracore.input.impact_force_properties.create_multi_cpt_impact_force_report_payload"]], "create_prepal_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_prepal_payload"]], "create_single_cpt_impact_force_payload() (in module pyvibracore.input.impact_force_properties)": [[2, "pyvibracore.input.impact_force_properties.create_single_cpt_impact_force_payload"]], "create_single_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_single_payload"]], "create_vibration_report_payload() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.create_vibration_report_payload"]], "from_api_response() (pyvibracore.results.impact_force_result.multicalculationdata class method)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.from_api_response"]], "from_api_response() (pyvibracore.results.impact_force_result.singlecalculationdata class method)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData.from_api_response"]], "from_api_response() (pyvibracore.results.vibration_result.vibrationresults class method)": [[2, "pyvibracore.results.vibration_result.VibrationResults.from_api_response"]], "gdf (pyvibracore.results.impact_force_result.multicalculationdata attribute)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.gdf"]], "gdf (pyvibracore.results.vibration_result.vibrationresults attribute)": [[2, "pyvibracore.results.vibration_result.VibrationResults.gdf"]], "get_buildings_geodataframe() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.get_buildings_geodataframe"]], "get_cur166_calculation() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_cur166_calculation"]], "get_cur166_report() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_cur166_report"]], "get_impact_force_calculation() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_impact_force_calculation"]], "get_impact_force_report() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_impact_force_report"]], "get_normative_building() (in module pyvibracore.input.vibration_properties)": [[2, "pyvibracore.input.vibration_properties.get_normative_building"]], "get_normative_building() (in module pyvibracore.results.sound_result)": [[2, "pyvibracore.results.sound_result.get_normative_building"]], "get_prepal_calculation() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_prepal_calculation"]], "get_prepal_report() (in module pyvibracore.api)": [[2, "pyvibracore.api.get_prepal_report"]], "map() (pyvibracore.results.vibration_result.vibrationresults method)": [[2, "pyvibracore.results.vibration_result.VibrationResults.map"]], "map_payload() (in module pyvibracore.results.vibration_result)": [[2, "pyvibracore.results.vibration_result.map_payload"]], "map_sound() (in module pyvibracore.results.sound_result)": [[2, "pyvibracore.results.sound_result.map_sound"]], "plot() (pyvibracore.results.impact_force_result.multicalculationdata method)": [[2, "pyvibracore.results.impact_force_result.MultiCalculationData.plot"]], "plot() (pyvibracore.results.impact_force_result.singlecalculationdata method)": [[2, "pyvibracore.results.impact_force_result.SingleCalculationData.plot"]], "plot_reduction() (in module pyvibracore.results.vibration_result)": [[2, "pyvibracore.results.vibration_result.plot_reduction"]]}})
\ No newline at end of file
diff --git a/tree/reference.html b/tree/reference.html
index f461852..13a10b4 100644
--- a/tree/reference.html
+++ b/tree/reference.html
@@ -235,15 +235,15 @@ 
Impact Force
Input

 

 

-pyvibracore.input.impact_force_properties.create_multi_cpt_impact_force_payload(cptdata_objects, classify_tables, vibration_source, friction_strategy, drive_strategy, installation_level_offset, zeta=0.6)[source]

+pyvibracore.input.impact_force_properties.create_multi_cpt_impact_force_payload(cptdata_objects, classify_tables, vibration_source, friction_strategy, drive_strategy, installation_level_offset, groundwater_level_offset=None, zeta=0.6)[source]
 
Creates a dictionary with the payload content for the VibraCore endpoint
 “/impact-force/calculation/multi”

 
This dictionary can be passed directly to nuclei.client.call_endpoint().

 

 
Parameters:

 
    
-
  • cptdata_objects (List[CPTData]) – A list of pygef.CPTData objects
    • 
-
  • classify_tables (Dict[str, dict]) – 
    A dictionary, mapping CPTData.alias values to dictionary with the resulting response
+
  • cptdata_objects (List[CPTData]) – A list of pygef.CPTData objects
    • 
+
  • classify_tables (Dict[str, dict]) – 
    A dictionary, mapping CPTData.alias values to dictionary with the resulting response
 of a call to CPTCore classify/* information, containing the following keys:
    
 
    
 
      
@@ -334,6 +334,8 @@ 
      Impact Force