Metadata-Version: 2.4
Name: gvp
Version: 0.1.0
Summary: The Volcanoes of the World database is a catalog of Holocene and Pleistocene volcanoes, and eruptions from the past 12,000 years.
Keywords: gvp,volcano,volcanism,observatory,volcanoes,volcanic,unrest,database,holocene
Author-email: Martanto <martanto@live.com>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
License-File: LICENSE
Requires-Dist: xlsxwriter>=3.2.5
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.2.2
Requires-Dist: importlib-resources
Requires-Dist: niquests>=3.15.2
Requires-Dist: notebook>=7.4.7
Requires-Dist: lxml>=6.0.2
Requires-Dist: tabulate>=0.9.0
Requires-Dist: pip ; extra == "dev"
Requires-Dist: isort ; extra == "dev"
Requires-Dist: black[d] ; extra == "dev"
Requires-Dist: xlsxwriter ; extra == "dev"
Requires-Dist: openpyxl ; extra == "dev"
Requires-Dist: pandas ; extra == "dev"
Requires-Dist: importlib-resources ; extra == "dev"
Project-URL: Homepage, https://github.com/martanto/gvp
Project-URL: Issues, https://github.com/martanto/gvp/issues
Provides-Extra: dev

# Global Volcanism Program (GVP)
Unofficial python package for Global Volcanism Program (GVP). Current database which is used in the package is Global Volcanism Program - Volcanoes of the World v5.3.2; 30 September 2025.

GVP Homepage: https://volcano.si.edu/

## Install

Using `pip`:
```python
pip install gvp
```

Using `uv`:
```python
uv add gvp
```

## Download Database
Available databases: holocene, pleistocene, and changelogs. Each database will be downloaded as an Excel file. The Excel files have also been fixed to prevent warnings when opened in Microsoft Excel.

### Import GVP module
```python
import gvp
from gvp.download import download

## Check GVP Module version
print(gvp.__version__)
```
`verbose` default parameter is set to `False`

### Download Holocone
```python
download(database="holocene", verbose=True)
```

### Download Pleistocene
```python
download(database="pleistocene", verbose=True)
```

### Download Changelogs in Markdown and Excel
```python
download(database="changelogs", verbose=True)
```

## Full code example
```python
import gvp
from gvp.download import download

download(database="holocene", verbose=True)
download(database="pleistocene", verbose=True)
download(database="changelogs", verbose=True)
```
