Metadata-Version: 2.1
Name: solvis
Version: 0.12.3
Summary: analysis of opensha modular solution files.
License: AGPL3
Author: Chris Chamberlain
Author-email: chrisbc@artisan.co.nz
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: demo
Provides-Extra: scripts
Provides-Extra: vtk
Requires-Dist: boto3 (>=1.26.82,<2.0.0) ; extra == "scripts"
Requires-Dist: click (>=8.1.3,<9.0.0) ; extra == "scripts"
Requires-Dist: click-plugins (>=1.1.1,<2.0.0) ; extra == "scripts"
Requires-Dist: geopandas (>=0.13.2,<0.14.0)
Requires-Dist: nshm-toshi-client (>=1.0.0,<2.0.0) ; extra == "scripts"
Requires-Dist: numpy (<1.25)
Requires-Dist: nzshm-common (>=0.8.1,<0.9.0)
Requires-Dist: nzshm-model (>=0.10.6,<0.11.0)
Requires-Dist: pyproj (>=3.3,<4.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: pytz (==2021.3)
Requires-Dist: pyvista (>=0.37.0,<0.38.0) ; extra == "vtk"
Description-Content-Type: text/markdown

# Solvis
A library to support the analysis of [OpenSHA](https://opensha.org/) inversion solution data.

[![pypi](https://img.shields.io/pypi/v/solvis.svg)](https://pypi.org/project/solvis/)
[![python](https://img.shields.io/pypi/pyversions/solvis.svg)](https://pypi.org/project/solvis/)
[![Build Status](https://github.com/GNS-Science/solvis/actions/workflows/dev.yml/badge.svg)](https://github.com/GNS-Science/solvis/actions/workflows/dev.yml)
[![codecov](https://codecov.io/gh/GNS-Science/solvis/branch/main/graphs/badge.svg)](https://codecov.io/github/GNS-Science/solvis)

Solvis is used in the geospatial investigation of the New Zealand
[National Seismic Hazard
Model](https://www.gns.cri.nz/research-projects/national-seismic-hazard-model/)
inversion sources and rates. It supports both individual inversions
and the composite model.

* Documentation: <https://GNS-Science.github.io/solvis>
* GitHub: <https://github.com/GNS-Science/solvis>
* PyPI: <https://pypi.org/project/solvis/>
* Free software: GNU Affero General Public License v3.0

# Features / Goals

Solvis is used in the analysis of OpenSHA
[Modular Fault System Solution](https://opensha.org/Modular-Fault-System-Solution) files.

From a typical modular OpenSHA Inversion Solution archive, we can produce views that
allow deep exploration of the solution and rupture set characteristics.

- Select a set of ruptures matching:
    - one or more parent faults
    - one or more corupture fault names
    - the vicinity of one or more named `nzshm-common` locations
    - defined regions
- Create new region polygons
- Determine geometric features, such as dip direction relative to strike bearing
- Calculate the geometries of solution and fault surfaces projected onto the Earth surface
- Calculate fault sections with their rupture rates and solution slip rates
- Generate Magnitude-Frequency Distribution (MFD) histogram data


## Install (Linux, WSL, OSX)

See [Installation](docs/installation.md) instructions.

