Metadata-Version: 2.4
Name: nzshm-hazlab
Version: 0.1.4
Summary: A laboratory for exploring hazard models
Author-email: Chris DiCaprio <christopher.dicaprio@gmail.com>
License-Expression: AGPL-3.0
License-File: LICENSE
Requires-Python: <3.13,>=3.11
Requires-Dist: cartopy<0.25.0,>=0.24.1
Requires-Dist: matplotlib<4.0.0,>=3.10.3
Requires-Dist: numpy<2,>=1.26.4
Requires-Dist: nzshm-common>=0.9.3
Requires-Dist: nzshm-model>=0.14.2
Requires-Dist: pandas<3.0.0,>=2.2.3
Requires-Dist: toshi-hazard-post>=0.7.1
Requires-Dist: toshi-hazard-store>=2.0.0
Provides-Extra: interactive
Requires-Dist: ipython>=9.9.0; extra == 'interactive'
Requires-Dist: jupyterlab>=4.5.2; extra == 'interactive'
Description-Content-Type: text/markdown

# nzshm_hazlab
Python tools for post processing and visualizing hazard results for the NZSHM project.

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

## Features

nzshm-hazlab can retrieve "aggregate" hazard curves (mean and fractiles), display them with matplotlib, and calculate derivative products such as uniform hazard spectra (UHS).

Hazard curves can be retrieved from
- toshi-hazard-store databases
- OpenQuake output files
- PLANNED FEATURE: plot aggregate curves generated on-the-fly with toshi-hazard-post

![hazard curve](docs/figs/hazard_curve_example.png)

## Install

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