Feature/42 participation rate filter

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.12.3
+current_version = 0.13.0
 commit = True
 tag = True
 

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [0.13.0] 2024-*
+
+## Changed
+ - 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;
+ - many old functions are deprecated/migrated to new filter package
+ - refactor dataframe dtypes
+ - standardise participation functions API and return columns;
+
+## Added
+ - new filter package providing classes for filtering solotions
+ - support for 3d geometry (thanks @voj)
+ - c3ab6da simplify FSS participation using rate_weighted_mean
+ - participation performance testing;
+ - added participation methods to fault_system_solution
+ - a simple rupture grouping algorithm (can this be a different type of filter??);
+ - `pandera` library for dataframe model validations and better docs
+
 ## [0.12.3] 2024-07-04
 bump version to verify new pypi workflow
 

docs/api/filter/chainable_set_base.md

@@ -0,0 +1 @@
+::: solvis.filter.chainable_set_base

docs/api/filter/index.md

@@ -0,0 +1,3 @@
+::: solvis.filter
+<!--     options:
+        show_root_heading: false -->

docs/api/filter/parent_fault_id_filter.md

@@ -0,0 +1 @@
+::: solvis.filter.parent_fault_id_filter

docs/api/filter/rupture_id_filter.md

@@ -0,0 +1 @@
+::: solvis.filter.rupture_id_filter

docs/api/filter/subsection_id_filter.md

@@ -0,0 +1 @@
+::: solvis.filter.subsection_id_filter

docs/api/inversion_solution/dataframe_models.md

@@ -0,0 +1,44 @@
+::: solvis.inversion_solution.dataframe_models
+    options:
+       inherited_members: false
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.FaultSectionSchemaBase
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.FaultSectionSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.FaultSectionRuptureRateSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.FaultSectionWithSolutionSlipRate
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.ParentFaultParticipationSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.RuptureSectionSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.RuptureSectionsWithRuptureRatesSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.RupturesWithRuptureRatesSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.SectionParticipationSchema
+    options:
+       members: false
+
+::: solvis.inversion_solution.dataframe_models.RuptureRateSchema
+    options:
+       members: false

docs/api/inversion_solution/fault_system_solution.md

@@ -1 +1,13 @@
 ::: solvis.inversion_solution.fault_system_solution
+	options:
+		members: false
+
+::: solvis.inversion_solution.fault_system_solution.FaultSystemSolution
+    options:
+       inherited_members: false
+       members_order: alphabetical
+       filters:
+       	- "![A-Z]+"
+       	- "!set_props"
+       	- "!^_"
+       group_by_category: false

docs/api/inversion_solution/inversion_solution.md

@@ -1 +1,10 @@
 ::: solvis.inversion_solution.inversion_solution
+
+::: solvis.inversion_solution.inversion_solution.InversionSolution
+    options:
+       inherited_members: false
+       members_order: alphabetical
+       filters:
+         - "!^_"
+         - "![A-Z]+"
+

docs/api/inversion_solution/inversion_solution_file.md

@@ -1,10 +1,6 @@
 ::: solvis.inversion_solution.inversion_solution_file
-    options:
+<!--     options:
         docstring_options:
             ignore_init_summary: false
-        merge_init_into_class: true
-        members:
-        - WARNING
-        - InversionSolutionFile
-        - data_to_zip_direct
-        - reindex_dataframe
+        merge_init_into_class: true -->
+

docs/api/inversion_solution/inversion_solution_operations.md

@@ -1,5 +1,17 @@
 ::: solvis.inversion_solution.inversion_solution_operations
     options:
+        members: false
+
+::: solvis.inversion_solution.inversion_solution_operations.InversionSolutionOperations
+    options:
+        inherited_members: false
         filters:
         - "!^_[^_]"
-        - "!^get_ruptures_"  # Deprecated function signatures
+        - "!^get_"  # Deprecated function signatures
+        members_order: alphabetical
+        group_by_category: false
+
+::: solvis.inversion_solution.inversion_solution_operations.CompositeSolutionOperations
+    options:
+        inherited_members: false
+        members_order: alphabetical

docs/api/inversion_solution/named_fault.md

@@ -0,0 +1 @@
+::: solvis.inversion_solution.named_fault

docs/api/solvis/geometry.md

@@ -1,3 +1,3 @@
 ::: solvis.geometry
-    options:
-        annotations_path: full
+<!--     options:
+        annotations_path: full -->

docs/usage.md

@@ -32,6 +32,8 @@ composite_solution = solvis.CompositeSolution.from_archive(
 
 ## Refining solution data
 
+*this section is the deprecated API, users should migrate to use the new [filter API](/solvis/api/filter)*
+
 To gather rupture IDs from a fault system solution:
 
 ```py

mkdocs.yml

@@ -2,7 +2,7 @@ site_name: Solvis Documentation
 site_url: https://gns-science.github.io/solvis
 repo_url: https://github.com/GNS-Science/solvis
 repo_name: GNS-Science/solvis
-strict: true
+# strict: true
 watch:
   - solvis
   - docs
@@ -11,21 +11,29 @@ nav:
   - Usage: usage.md
   - Installation: installation.md
   - API Reference:
-    - Solvis [package]:
+    - solvis:
       - api/solvis/index.md
-      - api/solvis/config.md
-      - api/solvis/geometry.md
-      - inversion_solution [package]:
+      - filter:
+        - filter: api/filter/index.md
+        - parent_fault_id_filter: api/filter/parent_fault_id_filter.md
+        - 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
-        - api/inversion_solution/composite_solution.md
-        - api/inversion_solution/fault_system_solution.md
-        - api/inversion_solution/fault_system_solution_file.md
-        - api/inversion_solution/inversion_solution.md
-        - api/inversion_solution/inversion_solution_operations.md
-        - api/inversion_solution/inversion_solution_file.md
-        - api/inversion_solution/solution_surfaces_builder.md
-        - api/inversion_solution/typing.md
-      - api/solvis/solvis.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
+      - config [module]: api/solvis/config.md
+      - geometry [module]: api/solvis/geometry.md
+      - solvis [module]: api/solvis/solvis.md
   - Development and Contributing:
     - contributing.md
     - Testing: testing.md