RSSeismicScripting 3.0.0__tar.gz → 3.0.1__tar.gz

{rsseismicscripting-3.0.0/src/RSSeismicScripting.egg-info → rsseismicscripting-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RSSeismicScripting
-Version: 3.0.0
+Version: 3.0.1
 Summary: Client library for interacting with RSSeismic (DeepSoil) through Python
 Author: Rocscience
 License-Expression: MIT
@@ -20,11 +20,11 @@ Dynamic: license-file
 
 ## Introduction
 
-This repo contains the reference manual for the RSSeismic scripting library. The RSSeismic scripting library is used to interact with the RSSeismic application through Python.
+This project is a library that can be used to interact with RSSeismic through python.
 
 | Resource | Link |
 |----------|------|
-| **Reference manual (this site)** | https://rocscience.github.io/rsseismic-scripting/ |
+| **Reference manual** | https://rocscience.github.io/rsseismic-scripting/ |
 | **PyPI package** | https://pypi.org/project/RSSeismicScripting/ |
 | **RSSeismic release notes** | https://www.rocscience.com/support/rsseismic/release-notes |
 | **Program downloads** | https://www.rocscience.com/support/program-downloads |
@@ -58,6 +58,18 @@ The library exposes a focused set of RSSeismic workflows through Python. In this
 
 - **Application connection**: Launch RSSeismic with the scripting server (`startApplication`), connect on a port, `ping`, open `.rsseismicfile` projects, create blank projects, adjust `maxConcurrentAnalyses`, run **batch compute** across many project files, and close the client connection.
 
+- **Application preferences (`app.preferences`)**: Default unit system for new projects, maximum concurrent analyses during compute, and results working directory.
+
+- **Motion library (`app.MotionLibrary`)**: Without an open project—convert plain-text or PEER AT2 files into Motion Manager folders, delete library motions, change Motion Manager display units, and open individual motions or horizontal pairs for analysis.
+
+- **Ground-motion databases**: Sign in to GMDB, CESMD, or ESM, search with filters, and import records into a Motion Manager preference folder.
+
+- **Target spectra and matching**: Build target spectra (user-defined, REXEL, or NSHMP), match horizontal motion pairs to targets manually or with automatic record selection, and read scale factors from the match results.
+
+- **Motion and pair analysis**: Motion properties; time histories and response spectra as **pandas DataFrames**; amplitude scaling; baseline correction and timestep reduction; kappa estimation; pair geometric-mean spectra and effective amplitude spectra; discover H1/H2 pairs in a folder by shared file prefix.
+
+- **RSLog (`RSLog`)**: Authenticate (including two-factor), list RSLog projects and boreholes, and import boreholes into the open project from RSLog or a JSON export.
+
 - **Project lifecycle (`Model`)**: Save, save as, close, **run compute** (with optional timeout and partial-success handling), clear results, and automatic profile **generate** / **reset** when that feature is enabled on the project.
 
 - **Profiles (`model.Profiles`)**: List, create, copy, delete, and rename profiles; active profile; list soil layers and bedrock; output depths; get **SoilLayer** / **BedrockLayer** property proxies.
@@ -72,17 +84,22 @@ The library exposes a focused set of RSSeismic workflows through Python. In this
 
 - **Ground motions (`model.Motions`)**: Motion directory preferences (add/remove/list), refresh project motion list, **uni-directional** motion list/selection or **bi-directional** pair list/selection, select-all and per-directory select/deselect.
 
-- **Layer properties**: **SoilLayer** (thickness, soil model, unit weight, …), **ReferenceCurve** (curve model, points, generate reference curve on profile layers), **SoilLayerCurve** (dynamics, discrete points, **curve fit** via `FittingProcedureModel`), **BedrockLayer** on realized profiles.
+- **Damping formulation (`model.DampingFormulation`)**: Read and set project damping (frequency-independent or Rayleigh), apply recommended modal frequencies, and export damping-curve and frequency/time-domain solution tables as **pandas DataFrames**.
+
+- **Layer properties**: **SoilLayer** (thickness, soil model, unit weight, …), **ReferenceCurve** (curve model, points, generate reference curve on profile layers), **SoilLayerCurve** (dynamics, discrete points, **curve fit** via `FittingProcedureModel`, including Rollins (2020) and Alemu (2025)), **BedrockLayer** on realized profiles.
+
+- **Single-element test (`ElementTestLayer`)**: Create a single-element layer on the active profile, set layer properties, run the element test, and read strain-path results.
 
 - **Results (`model.Results`)**: Result paths and database metadata; compute-aligned motion/layer discovery; **pandas DataFrames** for profile/layer time histories, profile summaries, result series (`ResultSeriesKind`), strain convergence, and real-time displacement; bulk fetch helpers for many motions/layers.
 
 - **Public types and enums**: Summary dataclasses (`ProfileSummary`, `MotionInfo`, `ResultDatabaseInfo`, …), `ResultSeriesKind`, `ResultMotionType`, `UnitSystem`, and property enums under `rsseismic.enums` (for example `SoilModel`, `AnalysisMode`, `InputMotionConfiguration`, `FittingProcedureModel`).
 
-RPC failures raise **`ScriptingError`**. Some successful RPCs carry advisory text in `errorMessage`; the client logs those as **warnings** (for example duplicate motion directory add).
-
 For method-level detail, use the [Scripting reference manual](https://rocscience.github.io/rsseismic-scripting/) (API reference and example scripts).
 
 ## Getting Started
 
-- **Tutorials and workflows (Rocscience Help):** https://www.rocscience.com/help/rsseismic/tutorials/
-- **Product documentation:** https://www.rocscience.com/help/rsseismic/documentation/
+- **Getting started guide** 
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/getting-started-with-rsseismic-python-scripting
+- **Tutorials** 
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/building-a-single-profile-and-running-an-analysis
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/building-multiple-projects-and-running-batch-processing

{rsseismicscripting-3.0.0 → rsseismicscripting-3.0.1}/README.md

@@ -1,10 +1,10 @@
 ## Introduction
 
-This repo contains the reference manual for the RSSeismic scripting library. The RSSeismic scripting library is used to interact with the RSSeismic application through Python.
+This project is a library that can be used to interact with RSSeismic through python.
 
 | Resource | Link |
 |----------|------|
-| **Reference manual (this site)** | https://rocscience.github.io/rsseismic-scripting/ |
+| **Reference manual** | https://rocscience.github.io/rsseismic-scripting/ |
 | **PyPI package** | https://pypi.org/project/RSSeismicScripting/ |
 | **RSSeismic release notes** | https://www.rocscience.com/support/rsseismic/release-notes |
 | **Program downloads** | https://www.rocscience.com/support/program-downloads |
@@ -38,6 +38,18 @@ The library exposes a focused set of RSSeismic workflows through Python. In this
 
 - **Application connection**: Launch RSSeismic with the scripting server (`startApplication`), connect on a port, `ping`, open `.rsseismicfile` projects, create blank projects, adjust `maxConcurrentAnalyses`, run **batch compute** across many project files, and close the client connection.
 
+- **Application preferences (`app.preferences`)**: Default unit system for new projects, maximum concurrent analyses during compute, and results working directory.
+
+- **Motion library (`app.MotionLibrary`)**: Without an open project—convert plain-text or PEER AT2 files into Motion Manager folders, delete library motions, change Motion Manager display units, and open individual motions or horizontal pairs for analysis.
+
+- **Ground-motion databases**: Sign in to GMDB, CESMD, or ESM, search with filters, and import records into a Motion Manager preference folder.
+
+- **Target spectra and matching**: Build target spectra (user-defined, REXEL, or NSHMP), match horizontal motion pairs to targets manually or with automatic record selection, and read scale factors from the match results.
+
+- **Motion and pair analysis**: Motion properties; time histories and response spectra as **pandas DataFrames**; amplitude scaling; baseline correction and timestep reduction; kappa estimation; pair geometric-mean spectra and effective amplitude spectra; discover H1/H2 pairs in a folder by shared file prefix.
+
+- **RSLog (`RSLog`)**: Authenticate (including two-factor), list RSLog projects and boreholes, and import boreholes into the open project from RSLog or a JSON export.
+
 - **Project lifecycle (`Model`)**: Save, save as, close, **run compute** (with optional timeout and partial-success handling), clear results, and automatic profile **generate** / **reset** when that feature is enabled on the project.
 
 - **Profiles (`model.Profiles`)**: List, create, copy, delete, and rename profiles; active profile; list soil layers and bedrock; output depths; get **SoilLayer** / **BedrockLayer** property proxies.
@@ -52,17 +64,22 @@ The library exposes a focused set of RSSeismic workflows through Python. In this
 
 - **Ground motions (`model.Motions`)**: Motion directory preferences (add/remove/list), refresh project motion list, **uni-directional** motion list/selection or **bi-directional** pair list/selection, select-all and per-directory select/deselect.
 
-- **Layer properties**: **SoilLayer** (thickness, soil model, unit weight, …), **ReferenceCurve** (curve model, points, generate reference curve on profile layers), **SoilLayerCurve** (dynamics, discrete points, **curve fit** via `FittingProcedureModel`), **BedrockLayer** on realized profiles.
+- **Damping formulation (`model.DampingFormulation`)**: Read and set project damping (frequency-independent or Rayleigh), apply recommended modal frequencies, and export damping-curve and frequency/time-domain solution tables as **pandas DataFrames**.
+
+- **Layer properties**: **SoilLayer** (thickness, soil model, unit weight, …), **ReferenceCurve** (curve model, points, generate reference curve on profile layers), **SoilLayerCurve** (dynamics, discrete points, **curve fit** via `FittingProcedureModel`, including Rollins (2020) and Alemu (2025)), **BedrockLayer** on realized profiles.
+
+- **Single-element test (`ElementTestLayer`)**: Create a single-element layer on the active profile, set layer properties, run the element test, and read strain-path results.
 
 - **Results (`model.Results`)**: Result paths and database metadata; compute-aligned motion/layer discovery; **pandas DataFrames** for profile/layer time histories, profile summaries, result series (`ResultSeriesKind`), strain convergence, and real-time displacement; bulk fetch helpers for many motions/layers.
 
 - **Public types and enums**: Summary dataclasses (`ProfileSummary`, `MotionInfo`, `ResultDatabaseInfo`, …), `ResultSeriesKind`, `ResultMotionType`, `UnitSystem`, and property enums under `rsseismic.enums` (for example `SoilModel`, `AnalysisMode`, `InputMotionConfiguration`, `FittingProcedureModel`).
 
-RPC failures raise **`ScriptingError`**. Some successful RPCs carry advisory text in `errorMessage`; the client logs those as **warnings** (for example duplicate motion directory add).
-
 For method-level detail, use the [Scripting reference manual](https://rocscience.github.io/rsseismic-scripting/) (API reference and example scripts).
 
 ## Getting Started
 
-- **Tutorials and workflows (Rocscience Help):** https://www.rocscience.com/help/rsseismic/tutorials/
-- **Product documentation:** https://www.rocscience.com/help/rsseismic/documentation/
+- **Getting started guide** 
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/getting-started-with-rsseismic-python-scripting
+- **Tutorials** 
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/building-a-single-profile-and-running-an-analysis
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/building-multiple-projects-and-running-batch-processing

{rsseismicscripting-3.0.0 → rsseismicscripting-3.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "RSSeismicScripting"
-version = "3.0.0"
+version = "3.0.1"
 dependencies = [
   "grpcio>=1.64.1",
   "protobuf<6.0",

{rsseismicscripting-3.0.0 → rsseismicscripting-3.0.1/src/RSSeismicScripting.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RSSeismicScripting
-Version: 3.0.0
+Version: 3.0.1
 Summary: Client library for interacting with RSSeismic (DeepSoil) through Python
 Author: Rocscience
 License-Expression: MIT
@@ -20,11 +20,11 @@ Dynamic: license-file
 
 ## Introduction
 
-This repo contains the reference manual for the RSSeismic scripting library. The RSSeismic scripting library is used to interact with the RSSeismic application through Python.
+This project is a library that can be used to interact with RSSeismic through python.
 
 | Resource | Link |
 |----------|------|
-| **Reference manual (this site)** | https://rocscience.github.io/rsseismic-scripting/ |
+| **Reference manual** | https://rocscience.github.io/rsseismic-scripting/ |
 | **PyPI package** | https://pypi.org/project/RSSeismicScripting/ |
 | **RSSeismic release notes** | https://www.rocscience.com/support/rsseismic/release-notes |
 | **Program downloads** | https://www.rocscience.com/support/program-downloads |
@@ -58,6 +58,18 @@ The library exposes a focused set of RSSeismic workflows through Python. In this
 
 - **Application connection**: Launch RSSeismic with the scripting server (`startApplication`), connect on a port, `ping`, open `.rsseismicfile` projects, create blank projects, adjust `maxConcurrentAnalyses`, run **batch compute** across many project files, and close the client connection.
 
+- **Application preferences (`app.preferences`)**: Default unit system for new projects, maximum concurrent analyses during compute, and results working directory.
+
+- **Motion library (`app.MotionLibrary`)**: Without an open project—convert plain-text or PEER AT2 files into Motion Manager folders, delete library motions, change Motion Manager display units, and open individual motions or horizontal pairs for analysis.
+
+- **Ground-motion databases**: Sign in to GMDB, CESMD, or ESM, search with filters, and import records into a Motion Manager preference folder.
+
+- **Target spectra and matching**: Build target spectra (user-defined, REXEL, or NSHMP), match horizontal motion pairs to targets manually or with automatic record selection, and read scale factors from the match results.
+
+- **Motion and pair analysis**: Motion properties; time histories and response spectra as **pandas DataFrames**; amplitude scaling; baseline correction and timestep reduction; kappa estimation; pair geometric-mean spectra and effective amplitude spectra; discover H1/H2 pairs in a folder by shared file prefix.
+
+- **RSLog (`RSLog`)**: Authenticate (including two-factor), list RSLog projects and boreholes, and import boreholes into the open project from RSLog or a JSON export.
+
 - **Project lifecycle (`Model`)**: Save, save as, close, **run compute** (with optional timeout and partial-success handling), clear results, and automatic profile **generate** / **reset** when that feature is enabled on the project.
 
 - **Profiles (`model.Profiles`)**: List, create, copy, delete, and rename profiles; active profile; list soil layers and bedrock; output depths; get **SoilLayer** / **BedrockLayer** property proxies.
@@ -72,17 +84,22 @@ The library exposes a focused set of RSSeismic workflows through Python. In this
 
 - **Ground motions (`model.Motions`)**: Motion directory preferences (add/remove/list), refresh project motion list, **uni-directional** motion list/selection or **bi-directional** pair list/selection, select-all and per-directory select/deselect.
 
-- **Layer properties**: **SoilLayer** (thickness, soil model, unit weight, …), **ReferenceCurve** (curve model, points, generate reference curve on profile layers), **SoilLayerCurve** (dynamics, discrete points, **curve fit** via `FittingProcedureModel`), **BedrockLayer** on realized profiles.
+- **Damping formulation (`model.DampingFormulation`)**: Read and set project damping (frequency-independent or Rayleigh), apply recommended modal frequencies, and export damping-curve and frequency/time-domain solution tables as **pandas DataFrames**.
+
+- **Layer properties**: **SoilLayer** (thickness, soil model, unit weight, …), **ReferenceCurve** (curve model, points, generate reference curve on profile layers), **SoilLayerCurve** (dynamics, discrete points, **curve fit** via `FittingProcedureModel`, including Rollins (2020) and Alemu (2025)), **BedrockLayer** on realized profiles.
+
+- **Single-element test (`ElementTestLayer`)**: Create a single-element layer on the active profile, set layer properties, run the element test, and read strain-path results.
 
 - **Results (`model.Results`)**: Result paths and database metadata; compute-aligned motion/layer discovery; **pandas DataFrames** for profile/layer time histories, profile summaries, result series (`ResultSeriesKind`), strain convergence, and real-time displacement; bulk fetch helpers for many motions/layers.
 
 - **Public types and enums**: Summary dataclasses (`ProfileSummary`, `MotionInfo`, `ResultDatabaseInfo`, …), `ResultSeriesKind`, `ResultMotionType`, `UnitSystem`, and property enums under `rsseismic.enums` (for example `SoilModel`, `AnalysisMode`, `InputMotionConfiguration`, `FittingProcedureModel`).
 
-RPC failures raise **`ScriptingError`**. Some successful RPCs carry advisory text in `errorMessage`; the client logs those as **warnings** (for example duplicate motion directory add).
-
 For method-level detail, use the [Scripting reference manual](https://rocscience.github.io/rsseismic-scripting/) (API reference and example scripts).
 
 ## Getting Started
 
-- **Tutorials and workflows (Rocscience Help):** https://www.rocscience.com/help/rsseismic/tutorials/
-- **Product documentation:** https://www.rocscience.com/help/rsseismic/documentation/
+- **Getting started guide** 
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/getting-started-with-rsseismic-python-scripting
+- **Tutorials** 
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/building-a-single-profile-and-running-an-analysis
+https://www.rocscience.com/help/rsseismic/tutorials/scripting/building-multiple-projects-and-running-batch-processing

{rsseismicscripting-3.0.0 → rsseismicscripting-3.0.1}/src/RSSeismicScripting.egg-info/SOURCES.txt

@@ -9,13 +9,18 @@ src/RSSeismicScripting.egg-info/top_level.txt
 src/rsseismic/Application.py
 src/rsseismic/ApplicationManager.py
 src/rsseismic/BedrockLayer.py
+src/rsseismic/DampingFormulation.py
+src/rsseismic/ElementTestLayer.py
 src/rsseismic/MeanProfile.py
 src/rsseismic/MeanProfileSoilLayer.py
 src/rsseismic/Model.py
+src/rsseismic/Motion.py
 src/rsseismic/Motions.py
+src/rsseismic/Preferences.py
 src/rsseismic/ProfileGenerationSettings.py
 src/rsseismic/Profiles.py
 src/rsseismic/ProjectSettings.py
+src/rsseismic/RSLog.py
 src/rsseismic/ReferenceCurve.py
 src/rsseismic/Results.py
 src/rsseismic/SoilLayer.py
@@ -44,6 +49,9 @@ src/rsseismic/generatedFiles/BedrockLayerDataService_pb2_grpc.py
 src/rsseismic/generatedFiles/CommonMessages_pb2.py
 src/rsseismic/generatedFiles/CommonMessages_pb2.pyi
 src/rsseismic/generatedFiles/CommonMessages_pb2_grpc.py
+src/rsseismic/generatedFiles/DampingFormulationService_pb2.py
+src/rsseismic/generatedFiles/DampingFormulationService_pb2.pyi
+src/rsseismic/generatedFiles/DampingFormulationService_pb2_grpc.py
 src/rsseismic/generatedFiles/MeanProfileService_pb2.py
 src/rsseismic/generatedFiles/MeanProfileService_pb2.pyi
 src/rsseismic/generatedFiles/MeanProfileService_pb2_grpc.py
@@ -53,9 +61,15 @@ src/rsseismic/generatedFiles/MeanProfileSoilLayerDataService_pb2_grpc.py
 src/rsseismic/generatedFiles/ModelService_pb2.py
 src/rsseismic/generatedFiles/ModelService_pb2.pyi
 src/rsseismic/generatedFiles/ModelService_pb2_grpc.py
+src/rsseismic/generatedFiles/MotionManagerService_pb2.py
+src/rsseismic/generatedFiles/MotionManagerService_pb2.pyi
+src/rsseismic/generatedFiles/MotionManagerService_pb2_grpc.py
 src/rsseismic/generatedFiles/MotionService_pb2.py
 src/rsseismic/generatedFiles/MotionService_pb2.pyi
 src/rsseismic/generatedFiles/MotionService_pb2_grpc.py
+src/rsseismic/generatedFiles/PreferencesService_pb2.py
+src/rsseismic/generatedFiles/PreferencesService_pb2.pyi
+src/rsseismic/generatedFiles/PreferencesService_pb2_grpc.py
 src/rsseismic/generatedFiles/ProfileGenerationSettingsService_pb2.py
 src/rsseismic/generatedFiles/ProfileGenerationSettingsService_pb2.pyi
 src/rsseismic/generatedFiles/ProfileGenerationSettingsService_pb2_grpc.py
@@ -65,12 +79,18 @@ src/rsseismic/generatedFiles/ProfileService_pb2_grpc.py
 src/rsseismic/generatedFiles/ProjectSettingsDataService_pb2.py
 src/rsseismic/generatedFiles/ProjectSettingsDataService_pb2.pyi
 src/rsseismic/generatedFiles/ProjectSettingsDataService_pb2_grpc.py
+src/rsseismic/generatedFiles/RSLogService_pb2.py
+src/rsseismic/generatedFiles/RSLogService_pb2.pyi
+src/rsseismic/generatedFiles/RSLogService_pb2_grpc.py
 src/rsseismic/generatedFiles/ReferenceCurveDataService_pb2.py
 src/rsseismic/generatedFiles/ReferenceCurveDataService_pb2.pyi
 src/rsseismic/generatedFiles/ReferenceCurveDataService_pb2_grpc.py
 src/rsseismic/generatedFiles/ResultsService_pb2.py
 src/rsseismic/generatedFiles/ResultsService_pb2.pyi
 src/rsseismic/generatedFiles/ResultsService_pb2_grpc.py
+src/rsseismic/generatedFiles/SingleElementTestService_pb2.py
+src/rsseismic/generatedFiles/SingleElementTestService_pb2.pyi
+src/rsseismic/generatedFiles/SingleElementTestService_pb2_grpc.py
 src/rsseismic/generatedFiles/SoilLayerCurveDataService_pb2.py
 src/rsseismic/generatedFiles/SoilLayerCurveDataService_pb2.pyi
 src/rsseismic/generatedFiles/SoilLayerCurveDataService_pb2_grpc.py
@@ -100,6 +120,9 @@ tests/test_auto_profile_workflow.py
 tests/test_batch_compute.py
 tests/test_bedrock_layer.py
 tests/test_connection.py
+tests/test_damping_formulation.py
+tests/test_damping_formulation_integration.py
+tests/test_element_test_layer.py
 tests/test_fem_verification_workflow.py
 tests/test_generated_enums.py
 tests/test_generated_property_enums.py
@@ -109,6 +132,7 @@ tests/test_model_generate_profiles.py
 tests/test_model_run_compute.py
 tests/test_motions.py
 tests/test_multi_open_scripting.py
+tests/test_preferences.py
 tests/test_profile_generation_settings.py
 tests/test_profiles.py
 tests/test_project_settings.py
@@ -119,6 +143,7 @@ tests/test_result_dataframes.py
 tests/test_results.py
 tests/test_results_dataframes_integration.py
 tests/test_rpc_helpers.py
+tests/test_rslog_workflow.py
 tests/test_single_profile_workflow.py
 tests/test_soil_layer.py
 tests/test_soil_layer_curve.py