# magma-var
Python package for MAGMA Volcano Eruption Notice (VEN)
# 1. How to use
Make sure you have MAGMA token. Check [examples directory](https://github.com/martanto/magma-ven/tree/main/examples).
Volcano name and code:
| Volcano | Code |
|--------------------| ------- |
| Agung | AGU |
| Ambang | AMB |
| Anak Krakatau | KRA |
| Anak Ranakah | RAN |
| Arjuno Welirang | WEL |
| Awu | AWU |
| Banda Api | BAN |
| Batur | BAT |
| Batutara | TAR |
| Bromo | BRO |
| Bur Ni Telong | TEL |
| Ciremai | CER |
| Colo | COL |
| Dempo | DEM |
| Dieng | DIE |
| Dukono | DUK |
| Ebulobo | EBU |
| Egon | EGO |
| Galunggung | GAL |
| Gamalama | GML |
| Gamkonora | GMK |
| Gede | GED |
| Guntur | GUN |
| Ibu | IBU |
| Ijen | IJE |
| Ile Werung | WER |
| Ili Boleng | BOL |
| Ili Lewotolok | LEW |
| Inielika | LIK |
| Inierie | RIE |
| Iya | IYA |
| Kaba | KAB |
| Karangetang | KAR |
| Kelimutu | KLM |
| Kelud | KLD |
| Kerinci | KER |
| Kie Besi | KIE |
| Lamongan | LAM |
| Lereboleng | LER |
| Lewotobi Laki-laki | LWK |
| Lewotobi Perempuan | LWP |
| Lokon | LOK |
| Mahawu | MAH |
| Marapi | MAR |
| Merapi | MER |
| Papandayan | PAP |
| Peut Sague | PEU |
| Raung | RAU |
| Rinjani | RIN |
| Rokatenda | ROK |
| Ruang | RUA |
| Salak | SAL |
| Sangeangapi | SAN |
| Semeru | SMR |
| Seulawah Agam | SEU |
| Sinabung | SIN |
| Sirung | SIR |
| Slamet | SLA |
| Soputan | SOP |
| Sorikmarapi | SOR |
| Sumbing | SBG |
| Sundoro | SUN |
| Talang | TAL |
| Tambora | TAM |
| Tandikat | TAN |
| Tangkoko | TGK |
| Tangkuban Parahu | TPR |
| Teon | TEO |
| Wurlali | WUR |
## 1.1 Install module
```pip
pip install magma-ven
```
Check your version:
```python
print(magma_ven.__version__)
```
## 1.2 Download Volcanic Eruption Notice (VEN)
To download Volcanic Eruption Notice (VEN):
### Import MAGMA VEN download module
```python
from magma_ven import Download
```
Initiate download:
```python
download = Download(
token="<token>", # replace with your MAGMA Token
volcano_code='IBU', # Volcano code
start_date='2025-01-01',
end_date='2025-07-30',
locale='en', # Default to "id"
verbose=True, # Show detailed information
debug=False # For development purpose
)
```
Start your download:
```python
download.ven()
```
Check VEN downloaded data:
```python
download.data
```
Check VEN DataFrame:
```python
download.df
```
Save as CSV or Excel:
```python
download.to_csv()
download.to_excel()
```
**Full code example**
```python
from magma_ven import Download
download = Download(
token="token",
volcano_code='IBU', # Check volcano table code above
start_date='2025-01-01',
end_date='2025-07-30',
locale='en',
verbose=True,
debug=False
)
# Starting to download
download.ven()
# Save into files
download.to_csv()
download.to_excel()
```
# Changelog
## [0.0.2] 2025-07-31
Update translation to english and add ability to save as file.
### Added
- Add english translation.
- Add ability to save as an excel or CSV
### Fixed
- Refactoring to source directory.
### Changed
- Add `locale` parameter to init VEN class
## [0.0.1] 2025-07-22
First release.
### Added
- First release.
### Fixed
- First release.
### Changed
- First release.
Raw data
{
"_id": null,
"home_page": null,
"name": "magma-ven",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "magma, indonesia, volcano, eruption, magma indonesia, volcanoes",
"author": null,
"author_email": "Martanto <martanto@live.com>, Devy Kamil Syahbana <devy.syahbana@gmail.com>, Syarif Abdul Manaf <riefmof@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5b/d7/6be931b20fc4e130093ff25e13601980805e79b53a2901dc88e263342bec/magma_ven-0.0.2.tar.gz",
"platform": null,
"description": "# magma-var\nPython package for MAGMA Volcano Eruption Notice (VEN)\n\n\n# 1. How to use\nMake sure you have MAGMA token. Check [examples directory](https://github.com/martanto/magma-ven/tree/main/examples).\n\nVolcano name and code: \n\n| Volcano | Code |\n|--------------------| ------- |\n| Agung | AGU |\n| Ambang | AMB |\n| Anak Krakatau | KRA |\n| Anak Ranakah | RAN |\n| Arjuno Welirang | WEL |\n| Awu | AWU |\n| Banda Api | BAN |\n| Batur | BAT |\n| Batutara | TAR |\n| Bromo | BRO |\n| Bur Ni Telong | TEL |\n| Ciremai | CER |\n| Colo | COL |\n| Dempo | DEM |\n| Dieng | DIE |\n| Dukono | DUK |\n| Ebulobo | EBU |\n| Egon | EGO |\n| Galunggung | GAL |\n| Gamalama | GML |\n| Gamkonora | GMK |\n| Gede | GED |\n| Guntur | GUN |\n| Ibu | IBU |\n| Ijen | IJE |\n| Ile Werung | WER |\n| Ili Boleng | BOL |\n| Ili Lewotolok | LEW |\n| Inielika | LIK |\n| Inierie | RIE |\n| Iya | IYA |\n| Kaba | KAB |\n| Karangetang | KAR |\n| Kelimutu | KLM |\n| Kelud | KLD |\n| Kerinci | KER |\n| Kie Besi | KIE |\n| Lamongan | LAM |\n| Lereboleng | LER |\n| Lewotobi Laki-laki | LWK |\n| Lewotobi Perempuan | LWP |\n| Lokon | LOK |\n| Mahawu | MAH |\n| Marapi | MAR |\n| Merapi | MER |\n| Papandayan | PAP |\n| Peut Sague | PEU |\n| Raung | RAU |\n| Rinjani | RIN |\n| Rokatenda | ROK |\n| Ruang | RUA |\n| Salak | SAL |\n| Sangeangapi | SAN |\n| Semeru | SMR |\n| Seulawah Agam | SEU |\n| Sinabung | SIN |\n| Sirung | SIR |\n| Slamet | SLA |\n| Soputan | SOP |\n| Sorikmarapi | SOR |\n| Sumbing | SBG |\n| Sundoro | SUN |\n| Talang | TAL |\n| Tambora | TAM |\n| Tandikat | TAN |\n| Tangkoko | TGK |\n| Tangkuban Parahu | TPR |\n| Teon | TEO |\n| Wurlali | WUR |\n\n\n## 1.1 Install module\n```pip\npip install magma-ven\n```\n\nCheck your version:\n```python\nprint(magma_ven.__version__)\n```\n\n## 1.2 Download Volcanic Eruption Notice (VEN)\nTo download Volcanic Eruption Notice (VEN):\n\n### Import MAGMA VEN download module\n```python\nfrom magma_ven import Download\n```\n\nInitiate download:\n```python\ndownload = Download(\n token=\"<token>\", # replace with your MAGMA Token\n volcano_code='IBU', # Volcano code\n start_date='2025-01-01', \n end_date='2025-07-30',\n locale='en', # Default to \"id\"\n verbose=True, # Show detailed information\n debug=False # For development purpose\n)\n```\n\nStart your download:\n```python\ndownload.ven()\n```\n\nCheck VEN downloaded data:\n```python\ndownload.data\n```\n\nCheck VEN DataFrame:\n```python\ndownload.df\n```\n\nSave as CSV or Excel:\n```python\ndownload.to_csv()\ndownload.to_excel()\n```\n\n**Full code example**\n```python\nfrom magma_ven import Download\n\ndownload = Download(\n token=\"token\",\n volcano_code='IBU', # Check volcano table code above\n start_date='2025-01-01',\n end_date='2025-07-30',\n locale='en',\n verbose=True,\n debug=False\n)\n\n# Starting to download\ndownload.ven()\n\n# Save into files\ndownload.to_csv()\ndownload.to_excel()\n```\n\n# Changelog\n## [0.0.2] 2025-07-31\n\nUpdate translation to english and add ability to save as file.\n\n### Added\n\n- Add english translation.\n- Add ability to save as an excel or CSV\n\n### Fixed\n\n- Refactoring to source directory.\n\n### Changed\n\n- Add `locale` parameter to init VEN class \n\n## [0.0.1] 2025-07-22\n\nFirst release.\n\n### Added\n\n- First release.\n\n### Fixed\n\n- First release.\n\n### Changed\n\n- First release.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "MAGMA Volcano Eruption Notice (VEN)",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/martanto/magma-ven",
"Issues": "https://github.com/martanto/magma-ven/issues"
},
"split_keywords": [
"magma",
" indonesia",
" volcano",
" eruption",
" magma indonesia",
" volcanoes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13d7c5f07a497b5e4593b037c30f538c3bcaf6e7f84765932a3dfa965959b25d",
"md5": "6d492bee710e3e35d0dcf8f2d19abc38",
"sha256": "bd968b65307b3379a8259624c9dd1f1e9248d4d1ce59273626e8329913aafab5"
},
"downloads": -1,
"filename": "magma_ven-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d492bee710e3e35d0dcf8f2d19abc38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10034,
"upload_time": "2025-07-31T11:22:41",
"upload_time_iso_8601": "2025-07-31T11:22:41.966902Z",
"url": "https://files.pythonhosted.org/packages/13/d7/c5f07a497b5e4593b037c30f538c3bcaf6e7f84765932a3dfa965959b25d/magma_ven-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5bd76be931b20fc4e130093ff25e13601980805e79b53a2901dc88e263342bec",
"md5": "de7cdad446d43792603eb3c09c25eb73",
"sha256": "f88fa5ed5c81be8285f95a8ebd38fbf2a80b52dec659deb2b114466ac791eb22"
},
"downloads": -1,
"filename": "magma_ven-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "de7cdad446d43792603eb3c09c25eb73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10004,
"upload_time": "2025-07-31T11:22:43",
"upload_time_iso_8601": "2025-07-31T11:22:43.411622Z",
"url": "https://files.pythonhosted.org/packages/5b/d7/6be931b20fc4e130093ff25e13601980805e79b53a2901dc88e263342bec/magma_ven-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 11:22:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "martanto",
"github_project": "magma-ven",
"github_not_found": true,
"lcname": "magma-ven"
}
JSON
