Metadata-Version: 2.4
Name: nshmdb
Version: 2026.8.1
Summary: A library for working with 2022 NSHM fault geometry
Author: ucgmsim
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: duckdb>=1.5.3
Requires-Dist: geojson>=3.3.0
Requires-Dist: numpy>=2.4.6
Requires-Dist: pandas>=3.0.3
Requires-Dist: pygmt-helper>=2026.2.1
Requires-Dist: pyproj>=3.7.2
Requires-Dist: qcore-utils>=2025.12.2
Requires-Dist: requests>=2.34.2
Requires-Dist: shapely>=2.1.2
Requires-Dist: source-modelling>=2026.6.2
Requires-Dist: typer>=0.26.7

# NSHM Database Generation

This repository contains a script and schema to generate a database storing fault geometry and rupture information parsing GeoJSON information from the GNS National Seismic Hazard Model.

## Obtain the database
You likely don't need to obtain your own database, as they are published on Dropbox at `/QuakeCoRE/Public/NSHM` with every version release. Simply download that file and use it with the package:

``` python
from nshmdb.nshmdb import NSHMDB

db = NSHMDB('nshmdb_v2026.06.1.db') # or whatever the latest version is.
```

## Generate your own database
After installing this package you simply run
```bash
nshmdb 1.0.4 nshmdb.db --api-key API_KEY_HERE
```
