| Name | magma-var JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | MAGMA Volcanic Activity Report (VAR) |
| upload_time | 2025-09-04 16:15:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
magma
indonesia
volcano
volcanoes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# magma-var
Python package for MAGMA Volcanic Activity Report (VAR)
# 1. How to use
Make sure you have MAGMA token. Check [examples directory](https://github.com/martanto/magma-var/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-var
```
Check your version:
```python
print(magma_var.__version__)
```
## 1.2 Download Volcanic Activity Report (VAR)
To download Volcanic Activity Report (VAR):
```python
import magma_var
from magma_auth import auth
from magma_var import Download
```
```python
print(magma_var.__version__)
```
```python
token = auth.token
```
```python
download = Download(
token=token,
volcano_code='LOK',
start_date='2025-01-01',
end_date='2025-06-08',
locale="id", # [testing] Change to "en" for english translation
current_dir='D:\\Projects\\magma-var', # Change your current directory. Default to None.
verbose=True,
)
```
```python
download.var()
```
```python
download.to_excel()
```
```python
download.to_csv()
```
## 1.3 Plot VAR
Plot seismicity count:
Earthquake name and code:
| Jenis Gempa | Earthquake (EN) | Code |
|---------------------|--------------------------------------|------|
| Semua Gempa | _Select all earthquake_ | * |
| Letusan | _Eruption_ | lts |
| Awan Panas Letusan | _Fountain Collapse Pyroclastic Flow_ | apl |
| Awan Panas Guguran | _Pyroclastic Density Current (PDC)_ | apg |
| Guguran | _Rockfall_ | gug |
| Hembusan | _Degassing_ | hbs |
| Harmonik | _Harmonic_ | hrm |
| Tremor Non-Harmonik | _Non-Harmonic Tremor_ | tre |
| Tornillo | _Tornillo_ | tor |
| Low Frequency | _Low Frequency_ | lof |
| Hybrid/Fase Banyak | _Hybrid/Multi Phase_ | hyb |
| Vulkanik Dangkal | _Shallow Volcanic-Tectonic (VT-B)_ | vtb |
| Vulkanik Dalam | _Deep Volcanic-Tectonic (VT-A)_ | vta |
| Very Long Period | _Very Long Period_ | vlp |
| Tektonik Lokal | _Local Tectonic_ | tel |
| Terasa | _Felt Earthquake_ | trs |
| Tektonik Jauh | _Teleseismic_ | tej |
| Double Event | _Double Event_ | dev |
| Getaran Banjir | _Lahar_ | gtb |
| Deep Tremor | _Deep Tremor_ | dpt |
| Tremor Menerus | _Tremor_ | mtr |
```python
from magma_auth import auth
from magma_var import Plot
```
```python
token = auth.token
```
```python
plot = Plot(
token = token,
volcano_code = 'LOK',
start_date = '2025-01-01',
end_date = '2025-03-13',
earthquake_code = '*', # Check table above for earthquake code
locale = 'en',
overwrite=True, # Overwrite existsing downloaded file
verbose=True, # Show detailed information
)
```
Print DataFrame:
```python
plot.df
```
Show plot:
```python
plot.show(
interval=7, # 7 days. X-axis interval in days.
width=1.0, # Size bar width
title='Lokon', # Plot title
figsize=(10,1),
title_fontsize=12,
figure_ylabel_fontsize=9,
x_labelsize=8,
y_labelsize=8,
color='black',
)
```
# Changelog
## [0.0.11] 2025-07-22
Expecting breaking changes from previous version.
### Added
- Added english translation in `resources.py` for earthquakes type.
- Added `debug` property for developing purposes.
### Fixed
- Increase performance by caching some results.
- Fix inconsistent output directory.
- Fix felt earthquake not detected.
### Changed
- `load_token()` method will unpack 3 variables, `success (bool)`, `token (str)`,
`expired_date (str)` instead of two variables `success (bool)` and `token (str)`.
- Code reformatting using `black`.
Raw data
{
"_id": null,
"home_page": null,
"name": "magma-var",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "magma, indonesia, volcano, 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/db/02/63f4ca974b0a66b99ea266c8076f7c115cade3ab1bc5a029e9167c320d08/magma_var-0.1.0.tar.gz",
"platform": null,
"description": "# magma-var\nPython package for MAGMA Volcanic Activity Report (VAR)\n\n# 1. How to use\nMake sure you have MAGMA token. Check [examples directory](https://github.com/martanto/magma-var/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-var\n```\n\nCheck your version:\n```python\nprint(magma_var.__version__)\n```\n\n## 1.2 Download Volcanic Activity Report (VAR)\nTo download Volcanic Activity Report (VAR):\n\n\n```python\nimport magma_var\nfrom magma_auth import auth\nfrom magma_var import Download\n```\n\n\n```python\nprint(magma_var.__version__)\n```\n\n\n```python\ntoken = auth.token\n```\n\n\n```python\ndownload = Download(\n token=token,\n volcano_code='LOK',\n start_date='2025-01-01',\n end_date='2025-06-08',\n locale=\"id\", # [testing] Change to \"en\" for english translation \n current_dir='D:\\\\Projects\\\\magma-var', # Change your current directory. Default to None.\n verbose=True,\n)\n```\n\n\n```python\ndownload.var()\n```\n\n\n```python\ndownload.to_excel()\n```\n\n\n```python\ndownload.to_csv()\n```\n\n\n## 1.3 Plot VAR\nPlot seismicity count:\n\nEarthquake name and code:\n\n| Jenis Gempa | Earthquake (EN) | Code |\n|---------------------|--------------------------------------|------|\n| Semua Gempa | _Select all earthquake_ | * |\n| Letusan | _Eruption_ | lts |\n| Awan Panas Letusan | _Fountain Collapse Pyroclastic Flow_ | apl |\n| Awan Panas Guguran | _Pyroclastic Density Current (PDC)_ | apg |\n| Guguran | _Rockfall_ | gug |\n| Hembusan | _Degassing_ | hbs |\n| Harmonik | _Harmonic_ | hrm |\n| Tremor Non-Harmonik | _Non-Harmonic Tremor_ | tre |\n| Tornillo | _Tornillo_ | tor |\n| Low Frequency | _Low Frequency_ | lof |\n| Hybrid/Fase Banyak | _Hybrid/Multi Phase_ | hyb |\n| Vulkanik Dangkal | _Shallow Volcanic-Tectonic (VT-B)_ | vtb |\n| Vulkanik Dalam | _Deep Volcanic-Tectonic (VT-A)_ | vta |\n| Very Long Period | _Very Long Period_ | vlp |\n| Tektonik Lokal | _Local Tectonic_ | tel |\n| Terasa | _Felt Earthquake_ | trs |\n| Tektonik Jauh | _Teleseismic_ | tej |\n| Double Event | _Double Event_ | dev |\n| Getaran Banjir | _Lahar_ | gtb |\n| Deep Tremor | _Deep Tremor_ | dpt |\n| Tremor Menerus | _Tremor_ | mtr |\n\n\n```python\nfrom magma_auth import auth\nfrom magma_var import Plot\n```\n\n\n```python\ntoken = auth.token\n```\n\n\n```python\nplot = Plot(\n token = token,\n volcano_code = 'LOK',\n start_date = '2025-01-01',\n end_date = '2025-03-13',\n earthquake_code = '*', # Check table above for earthquake code\n locale = 'en',\n overwrite=True, # Overwrite existsing downloaded file\n verbose=True, # Show detailed information\n)\n```\n\nPrint DataFrame:\n```python\nplot.df\n```\n\nShow plot:\n```python\nplot.show(\n interval=7, # 7 days. X-axis interval in days. \n width=1.0, # Size bar width\n title='Lokon', # Plot title\n figsize=(10,1),\n title_fontsize=12,\n figure_ylabel_fontsize=9,\n x_labelsize=8,\n y_labelsize=8,\n color='black',\n)\n```\n\n# Changelog\n## [0.0.11] 2025-07-22\n\nExpecting breaking changes from previous version.\n\n### Added\n\n- Added english translation in `resources.py` for earthquakes type.\n- Added `debug` property for developing purposes.\n\n### Fixed\n\n- Increase performance by caching some results.\n- Fix inconsistent output directory.\n- Fix felt earthquake not detected.\n\n### Changed\n\n- `load_token()` method will unpack 3 variables, `success (bool)`, `token (str)`, \n`expired_date (str)` instead of two variables `success (bool)` and `token (str)`.\n- Code reformatting using `black`.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "MAGMA Volcanic Activity Report (VAR)",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/martanto/magma-var",
"Issues": "https://github.com/martanto/magma-var/issues"
},
"split_keywords": [
"magma",
" indonesia",
" volcano",
" volcanoes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49826fc7ef5f966575e806d6a4a1b82c0e249c11cf52c8ef6961d80094581d37",
"md5": "66d1555b40319ff0537012414a742d1e",
"sha256": "9fca2729dfe8f306723d934c5ed339d7632a30165311dcc75797b832f3544482"
},
"downloads": -1,
"filename": "magma_var-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66d1555b40319ff0537012414a742d1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 17246,
"upload_time": "2025-09-04T16:15:04",
"upload_time_iso_8601": "2025-09-04T16:15:04.579674Z",
"url": "https://files.pythonhosted.org/packages/49/82/6fc7ef5f966575e806d6a4a1b82c0e249c11cf52c8ef6961d80094581d37/magma_var-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db0263f4ca974b0a66b99ea266c8076f7c115cade3ab1bc5a029e9167c320d08",
"md5": "68428674a5882c06ff02d6e587266df5",
"sha256": "1a096eab4ecc951a963f5be048abe9aad3c82e845f2f27ece519644668c54030"
},
"downloads": -1,
"filename": "magma_var-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "68428674a5882c06ff02d6e587266df5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 16636,
"upload_time": "2025-09-04T16:15:05",
"upload_time_iso_8601": "2025-09-04T16:15:05.507974Z",
"url": "https://files.pythonhosted.org/packages/db/02/63f4ca974b0a66b99ea266c8076f7c115cade3ab1bc5a029e9167c320d08/magma_var-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-04 16:15:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "martanto",
"github_project": "magma-var",
"github_not_found": true,
"lcname": "magma-var"
}
