GNS-Science · chrisbc · Oct 22, 2024 · Oct 22, 2024 · Oct 22, 2024 · Oct 24, 2024
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.13.0
+current_version = 0.12.3
 commit = True
 tag = True
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,11 +6,14 @@
  - drop_zero_rate differentiates between FSS and IS;
  - faster testing (~3 times faster)
  - documentation improvements
- - abc427e fixing many deprecation warnings; updated geopandas, pandas, numpy, pyvista libs;
- - read_csv dtype configuration improvements;
+ - fix many deprecation warnings
+ - updated dependencies: geopandas, pandas, numpy, pyvista libs
+ - read_csv dtype configuration improvements
  - many old functions are deprecated/migrated to new filter package
  - refactor dataframe dtypes
- - standardise participation functions API and return columns;
+ - standardise participation functions API and return columns
+ - refactor `solvis.inversion_solution` package to `solvis.solution` and collect modules into packages
+ - new packages `solvis.solution.inversion_solution` and  `solvis.solution.fault_system_solution`
 
 ## Added
  - new filter package providing classes for filtering solutions
@@ -21,6 +24,10 @@
  - a simple rupture grouping algorithm (can this be a different type of filter??);
  - `pandera` library for dataframe model validations and better docs
 
+## Removed
+ - deprecated `solvis.solvis` functions removed.
+ - deprecated `solvis.inversion_solution.*` functions/methods removed.
+
 ## [0.12.3] 2024-07-04
 bump version to verify new pypi workflow
 

diff --git a/docs/api/inversion_solution/composite_solution.md b/docs/api/inversion_solution/composite_solution.md
diff --git a/docs/api/inversion_solution/dataframe_models.md b/docs/api/inversion_solution/dataframe_models.md
diff --git a/docs/api/inversion_solution/fault_system_solution.md b/docs/api/inversion_solution/fault_system_solution.md
diff --git a/docs/api/inversion_solution/fault_system_solution_file.md b/docs/api/inversion_solution/fault_system_solution_file.md
diff --git a/docs/api/inversion_solution/index.md b/docs/api/inversion_solution/index.md
diff --git a/docs/api/inversion_solution/inversion_solution.md b/docs/api/inversion_solution/inversion_solution.md
diff --git a/docs/api/inversion_solution/named_fault.md b/docs/api/inversion_solution/named_fault.md
diff --git a/docs/api/inversion_solution/solution_surfaces_builder.md b/docs/api/inversion_solution/solution_surfaces_builder.md
diff --git a/docs/api/inversion_solution/typing.md b/docs/api/inversion_solution/typing.md
diff --git a/docs/api/solution/composite_solution.md b/docs/api/solution/composite_solution.md
@@ -0,0 +1 @@
+::: solvis.solution.composite_solution
diff --git a/docs/api/solution/dataframe_models.md b/docs/api/solution/dataframe_models.md
@@ -0,0 +1,44 @@
+::: solvis.solution.dataframe_models
+    options:
+       inherited_members: false
+       members: false
+
+::: solvis.solution.dataframe_models.FaultSectionSchemaBase
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.FaultSectionSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.FaultSectionRuptureRateSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.FaultSectionWithSolutionSlipRate
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.ParentFaultParticipationSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.RuptureSectionSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.RuptureSectionsWithRuptureRatesSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.RupturesWithRuptureRatesSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.SectionParticipationSchema
+    options:
+       members: false
+
+::: solvis.solution.dataframe_models.RuptureRateSchema
+    options:
+       members: false
diff --git a/docs/api/solution/fault_system_solution/fault_system_solution.md b/docs/api/solution/fault_system_solution/fault_system_solution.md
@@ -0,0 +1,13 @@
+::: solvis.solution.fault_system_solution.fault_system_solution
+<!-- 	options:
+		members: false
+
+::: solvis.solution.fault_system_solution.FaultSystemSolution
+    options:
+       inherited_members: false
+       members_order: alphabetical
+       filters:
+       	- "![A-Z]+"
+       	- "!set_props"
+       	- "!^_"
+       group_by_category: false -->
diff --git a/docs/api/solution/fault_system_solution/fault_system_solution_file.md b/docs/api/solution/fault_system_solution/fault_system_solution_file.md
@@ -0,0 +1 @@
+::: solvis.solution.fault_system_solution.fault_system_solution_file
diff --git a/docs/api/solution/fault_system_solution/fault_system_solution_model.md b/docs/api/solution/fault_system_solution/fault_system_solution_model.md
@@ -0,0 +1,12 @@
+::: solvis.solution.fault_system_solution.fault_system_solution_model
+    options:
+        members: false
+
+::: solvis.solution.fault_system_solution.fault_system_solution_model.FaultSystemSolutionModel
+    options:
+        inherited_members: true
+        filters:
+        - "!^_[^_]"
+        - "!^get_"  # Deprecated function signatures
+        members_order: alphabetical
+        group_by_category: false
diff --git a/docs/api/solution/fault_system_solution/index.md b/docs/api/solution/fault_system_solution/index.md
@@ -0,0 +1 @@
+::: solvis.solution.fault_system_solution
diff --git a/docs/api/solution/index.md b/docs/api/solution/index.md
@@ -0,0 +1 @@
+::: solvis.solution
diff --git a/docs/api/solution/inversion_solution/index.md b/docs/api/solution/inversion_solution/index.md
@@ -0,0 +1 @@
+::: solvis.solution.inversion_solution
diff --git a/docs/api/solution/inversion_solution/inversion_solution.md b/docs/api/solution/inversion_solution/inversion_solution.md
@@ -0,0 +1,3 @@
+::: solvis.solution.inversion_solution.inversion_solution
+
+
diff --git a/...rsion_solution/inversion_solution_file.md → ...rsion_solution/inversion_solution_file.md b/...rsion_solution/inversion_solution_file.md → ...rsion_solution/inversion_solution_file.md
@@ -1,4 +1,4 @@
-::: solvis.inversion_solution.inversion_solution_file
+::: solvis.solution.inversion_solution.inversion_solution_file
 <!--     options:
         docstring_options:
             ignore_init_summary: false

diff --git a/...solution/inversion_solution_operations.md → ...sion_solution/inversion_solution_model.md b/...solution/inversion_solution_operations.md → ...sion_solution/inversion_solution_model.md
@@ -1,8 +1,8 @@
-::: solvis.inversion_solution.inversion_solution_operations
+::: solvis.solution.inversion_solution.inversion_solution_model
     options:
         members: false
 
-::: solvis.inversion_solution.inversion_solution_operations.InversionSolutionOperations
+::: solvis.solution.inversion_solution.inversion_solution_model.InversionSolutionModel
     options:
         inherited_members: false
         filters:
@@ -11,7 +11,7 @@
         members_order: alphabetical
         group_by_category: false
 
-::: solvis.inversion_solution.inversion_solution_operations.CompositeSolutionOperations
+::: solvis.solution.inversion_solution.inversion_solution_model.CompositeSolutionModel
     options:
         inherited_members: false
         members_order: alphabetical
diff --git a/docs/api/solution/named_fault.md b/docs/api/solution/named_fault.md
@@ -0,0 +1 @@
+::: solvis.solution.named_fault
diff --git a/docs/api/solution/solution_surfaces_builder.md b/docs/api/solution/solution_surfaces_builder.md
@@ -0,0 +1 @@
+::: solvis.solution.solution_surfaces_builder
diff --git a/docs/api/solution/typing.md b/docs/api/solution/typing.md
@@ -0,0 +1 @@
+::: solvis.solution.typing
diff --git a/docs/usage.md b/docs/usage.md
@@ -10,9 +10,9 @@ A typical Solvis investigation starts with reading an archive into a solution ob
 
 Depending on the data type, you will need to use one of:
 
-- [`FaultSystemSolution.from_archive(instance_or_path)`][solvis.inversion_solution.fault_system_solution.FaultSystemSolution.from_archive]
-- [`InversionSolution.from_archive(instance_or_path)`][solvis.inversion_solution.inversion_solution.InversionSolution.from_archive]
-- [`CompositeSolution.from_archive(instance_or_path, slt)`][solvis.inversion_solution.composite_solution.CompositeSolution.from_archive]
+- [`FaultSystemSolution.from_archive(instance_or_path)`][solvis.solution.fault_system_solution.FaultSystemSolution.from_archive]
+- [`InversionSolution.from_archive(instance_or_path)`][solvis.solution.inversion_solution.InversionSolution.from_archive]
+- [`CompositeSolution.from_archive(instance_or_path, slt)`][solvis.solution.composite_solution.CompositeSolution.from_archive]
 
 Composite solutions require selecting an NSHM model version (usually 1.0.4), and constructing a
 solution from its source logic tree.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,18 +19,22 @@ nav:
         - rupture_id_filter: api/filter/rupture_id_filter.md
         - subsection_id_filter: api/filter/subsection_id_filter.md
         - chainable_set_base: api/filter/chainable_set_base.md
-      - inversion_solution:
-        - api/inversion_solution/index.md
-        - Dataframe Models: api/inversion_solution/dataframe_models.md
-        - Inversion Solution: api/inversion_solution/inversion_solution.md
-        - Fault System Solution: api/inversion_solution/fault_system_solution.md
-        - Composite Solution: api/inversion_solution/composite_solution.md
-        - Supporting modules:
-          - api/inversion_solution/fault_system_solution_file.md
-          - api/inversion_solution/inversion_solution_file.md
-          - api/inversion_solution/inversion_solution_operations.md
-          - api/inversion_solution/solution_surfaces_builder.md
-          - api/inversion_solution/typing.md
+      - solution:
+        - api/solution/index.md
+        - composite_solution: api/solution/composite_solution.md
+        - fault_system_solution:
+          - api/solution/fault_system_solution/index.md
+          - api/solution/fault_system_solution/fault_system_solution.md
+          - api/solution/fault_system_solution/fault_system_solution_file.md
+          - api/solution/fault_system_solution/fault_system_solution_model.md
+        - inversion_solution:
+          - api/solution/inversion_solution/index.md
+          - api/solution/inversion_solution/inversion_solution.md
+          - api/solution/inversion_solution/inversion_solution_file.md
+          - api/solution/inversion_solution/inversion_solution_model.md
+        - dataframe_models: api/solution/dataframe_models.md
+        - solution_surfaces_builder: api/solution/solution_surfaces_builder.md
+        - typing: api/solution/typing.md
       - config [module]: api/solvis/config.md
       - geometry [module]: api/solvis/geometry.md
       - solvis [module]: api/solvis/solvis.md
@@ -104,6 +108,12 @@ plugins:
             annotations_path: source
             # show_source: true
 
+            extensions:
+            - pydantic: {schema: true}
+            - solvis/dochelper/extension.py:DynamicDocstrings:
+                object_paths: [solvis.solution.inversion_solution.InversionSolution]
+
+
 extra:
   social:
     - icon: fontawesome/brands/github
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: solvis.solution.fault_system_solution.fault_system_solution_file
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		::: solvis.solution.inversion_solution.inversion_solution