| Name | vmod-geodesy JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | None |
| Summary | Versatile Modeling of Deformation |
| upload_time | 2024-08-25 21:03:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 UAF Geophysics Tools Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[comment]: <> (<img src="https://github.com/uafgeotools/vmod/assets/16811978/297cecd1-78d6-4146-9f7a-fc1c623f1cbf" width="300">)
<img src="https://github.com/uafgeotools/vmod/assets/16811978/8cc49246-df4c-43fb-9254-a8351d0ebc83" width="500">
# Versatile Modeling Of Deformation
[](https://doi.org/10.5281/zenodo.10070627)
<a target="_blank" href="https://colab.research.google.com/github/mfangaritav/vmod/blob/main/dvd_gnss_low_emcee.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>
### Authors: Mario Angarita, Ronni Grapenthin, Scott Henderson, Michael Christoffersen and Kyle Anderson
## What is VMOD?
VMOD is a python-based object oriented framework. Its main purpose is to model multiple types of geodetic data including:
- GNSS
- InSAR
- Level
- EDM
- Tilt
These observations can be interpreted with one or more analytical models that represent pressurized sources such as:
- Pressurized sphere in elastic medium
- Pressurized sphere in viscoelastic medium
- Pressurized sphere in a viscoelastic shell in elastic medium
- Pressurized prolate spheroid in elastic medium
- Dislocation (Fault/Sill) in elastic medium
- Penny shaped crack in elastic medium
- Point source in elastic medium
- Wellsite in porelastic medium
- Ring fault in elastic medium
- Regularized fault/sill in elastic medium
- Open conduit in elastic medium
The framework offers two different inversion techniques to solve for the source parameters:
- Non-linear least squares
- Bayesian approach
The inversions can include one or multiple data types in the inversion and the model can be composed by multiple sources. The user can customize or inherit current models to create complexer geometries.
## Standard Installation
We recommend using Anaconda or Miniconda to create an environment in which to install VMOD to prevent dependency conflicts.
```console
conda create --name vmod -c conda-forge "python=3.9.*" "pymc=2.3.8" "setuptools>=61"
```
PyMC must be installed with conda, pip fails to build version 2.3.8 on some machines.
```console
conda activate vmod
pip install vmod-geodesy
```
## Run an inversion:
In this repository we included several notebooks to show the steps necessary to run an inversion using [GNSS](dvd_gnss_low.ipynb), [InSAR](dvd_insar_low_off.ipynb), [EDM](example_synthetic_edm.ipynb) and [joint](dvd_joint_low.ipynb) datasets. We also included an example using real datasets on [Unimak Island](example_unimak_joint.ipynb).
## Add new datatype:
**Users wishing to include a new datatype should clone the source repository and create a new file in the data folder.** This file should contain a new class that inherit from the 'Data' class and that has the functions to initialize the attributes, adding the components belonging to the datatype and a function to derive the components from 3d displacements. For example, in the Insar class we defined the following functions:
```python
class Insar(Data):
def __init__():
...
def add_los(self, los):
...
def from_model3d(self, func):
...
```
## Add new model:
**Users wishing to include a new model should clone the source repository and create a new file in the source folder.** This file should contain a new class that inherit from the 'Source' class and that has a function returning the names of the parameters in your model and a function that gives the implementation of your model and return the 3d displacement. If you want to use this model with data that has a temporal dependency you should include the function 'model_t' that implements a time-dependant model. As an option you can include additional functions that return tilt displacements with the function 'model_tilt' or if it has a temporal dependency 'model_tilt_t'. For example, here we show the required functions in our Mogi model:
```python
class Mogi(Source):
def set_parnames(self):
...
def model(self, params):
...
```
## Publications:
A list of publications where VMOD has been used:
- Grapenthin, R., Cheng, Y., Angarita, M., Tan, D., Meyer, F. J., Fee, D., & Wech, A. (2022). Return from Dormancy: Rapid inflation and seismic unrest driven by transcrustal magma transfer at Mt. Edgecumbe (L’úx Shaa) Volcano, Alaska. Geophysical Research Letters, 49(20), e2022GL099464. https://doi.org/10.1029/2022GL099464
- Grapenthin, R., Kyle, P., Aster, R. C., Angarita, M., Wilson, T., & Chaput, J. (2022). Deformation at the open-vent Erebus volcano, Antarctica, from more than 20 years of GNSS observations. Journal of Volcanology and Geothermal Research, 432, 107703. https://doi.org/10.1016/j.jvolgeores.2022.107703
- Graves, E. J., et al. "InSAR-observed surface deformation in New Mexico’s Permian Basin shows threats and opportunities presented by leaky injection wells." Scientific Reports 13.1 (2023): 17308. https://doi.org/10.1038/s41598-023-42696-9
Raw data
{
"_id": null,
"home_page": null,
"name": "vmod-geodesy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Mario Angarita Vargas <mfangaritasr@alaska.edu>, Ronni Grapenthin <rgrapenthin@alaska.edu>, Scott Henderson <scottyh@uw.edu>, Michael Christoffersen <mchristoffersen@alaska.edu>, Kyle Anderson <kranderson@usgs.gov>",
"download_url": "https://files.pythonhosted.org/packages/8e/fc/cb1b4b19d2d40bb4fa673d94f8481f466cce66a567ac1474cc7c755f57c0/vmod_geodesy-1.0.3.tar.gz",
"platform": null,
"description": "[comment]: <> (<img src=\"https://github.com/uafgeotools/vmod/assets/16811978/297cecd1-78d6-4146-9f7a-fc1c623f1cbf\" width=\"300\">)\n<img src=\"https://github.com/uafgeotools/vmod/assets/16811978/8cc49246-df4c-43fb-9254-a8351d0ebc83\" width=\"500\">\n\n# Versatile Modeling Of Deformation\n[](https://doi.org/10.5281/zenodo.10070627)\n<a target=\"_blank\" href=\"https://colab.research.google.com/github/mfangaritav/vmod/blob/main/dvd_gnss_low_emcee.ipynb\">\n <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n</a>\n### Authors: Mario Angarita, Ronni Grapenthin, Scott Henderson, Michael Christoffersen and Kyle Anderson\n\n## What is VMOD?\n\nVMOD is a python-based object oriented framework. Its main purpose is to model multiple types of geodetic data including:\n\n- GNSS\n- InSAR\n- Level\n- EDM\n- Tilt\n\nThese observations can be interpreted with one or more analytical models that represent pressurized sources such as:\n\n- Pressurized sphere in elastic medium\n- Pressurized sphere in viscoelastic medium\n- Pressurized sphere in a viscoelastic shell in elastic medium\n- Pressurized prolate spheroid in elastic medium\n- Dislocation (Fault/Sill) in elastic medium\n- Penny shaped crack in elastic medium\n- Point source in elastic medium\n- Wellsite in porelastic medium\n- Ring fault in elastic medium\n- Regularized fault/sill in elastic medium\n- Open conduit in elastic medium\n\nThe framework offers two different inversion techniques to solve for the source parameters:\n\n- Non-linear least squares\n- Bayesian approach\n\nThe inversions can include one or multiple data types in the inversion and the model can be composed by multiple sources. The user can customize or inherit current models to create complexer geometries.\n\n\n\n## Standard Installation\n\nWe recommend using Anaconda or Miniconda to create an environment in which to install VMOD to prevent dependency conflicts.\n```console\nconda create --name vmod -c conda-forge \"python=3.9.*\" \"pymc=2.3.8\" \"setuptools>=61\"\n```\nPyMC must be installed with conda, pip fails to build version 2.3.8 on some machines.\n\n```console\nconda activate vmod\npip install vmod-geodesy\n```\n\n## Run an inversion:\n\nIn this repository we included several notebooks to show the steps necessary to run an inversion using [GNSS](dvd_gnss_low.ipynb), [InSAR](dvd_insar_low_off.ipynb), [EDM](example_synthetic_edm.ipynb) and [joint](dvd_joint_low.ipynb) datasets. We also included an example using real datasets on [Unimak Island](example_unimak_joint.ipynb).\n\n## Add new datatype:\n\n**Users wishing to include a new datatype should clone the source repository and create a new file in the data folder.** This file should contain a new class that inherit from the 'Data' class and that has the functions to initialize the attributes, adding the components belonging to the datatype and a function to derive the components from 3d displacements. For example, in the Insar class we defined the following functions:\n\n```python\nclass Insar(Data):\n def __init__():\n ...\n def add_los(self, los):\n ...\n def from_model3d(self, func):\n ...\n```\n\n## Add new model:\n\n**Users wishing to include a new model should clone the source repository and create a new file in the source folder.** This file should contain a new class that inherit from the 'Source' class and that has a function returning the names of the parameters in your model and a function that gives the implementation of your model and return the 3d displacement. If you want to use this model with data that has a temporal dependency you should include the function 'model_t' that implements a time-dependant model. As an option you can include additional functions that return tilt displacements with the function 'model_tilt' or if it has a temporal dependency 'model_tilt_t'. For example, here we show the required functions in our Mogi model:\n\n```python\nclass Mogi(Source):\n def set_parnames(self):\n ...\n def model(self, params):\n ...\n```\n\n## Publications:\n\nA list of publications where VMOD has been used:\n\n- Grapenthin, R., Cheng, Y., Angarita, M., Tan, D., Meyer, F. J., Fee, D., & Wech, A. (2022). Return from Dormancy: Rapid inflation and seismic unrest driven by transcrustal magma transfer at Mt. Edgecumbe (L\u2019\u00fax Shaa) Volcano, Alaska. Geophysical Research Letters, 49(20), e2022GL099464. https://doi.org/10.1029/2022GL099464\n- Grapenthin, R., Kyle, P., Aster, R. C., Angarita, M., Wilson, T., & Chaput, J. (2022). Deformation at the open-vent Erebus volcano, Antarctica, from more than 20 years of GNSS observations. Journal of Volcanology and Geothermal Research, 432, 107703. https://doi.org/10.1016/j.jvolgeores.2022.107703\n- Graves, E. J., et al. \"InSAR-observed surface deformation in New Mexico\u2019s Permian Basin shows threats and opportunities presented by leaky injection wells.\" Scientific Reports 13.1 (2023): 17308. https://doi.org/10.1038/s41598-023-42696-9\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 UAF Geophysics Tools Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Versatile Modeling of Deformation",
"version": "1.0.3",
"project_urls": {
"documentation": "https://github.com/uafgeotools/vmod",
"repository": "https://github.com/uafgeotools/vmod"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a04de426eb4f9bccc9f007808ab685e6e4cd5830d1a105b4ba24363cbc6d6341",
"md5": "4b756dab988f841e5773b40394267c9f",
"sha256": "7de2d64a19b3ca97c7052b51f831d24eef8cc07a5ef55c662e2c9653d5af4b89"
},
"downloads": -1,
"filename": "vmod_geodesy-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b756dab988f841e5773b40394267c9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 65975,
"upload_time": "2024-08-25T21:03:53",
"upload_time_iso_8601": "2024-08-25T21:03:53.623668Z",
"url": "https://files.pythonhosted.org/packages/a0/4d/e426eb4f9bccc9f007808ab685e6e4cd5830d1a105b4ba24363cbc6d6341/vmod_geodesy-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8efccb1b4b19d2d40bb4fa673d94f8481f466cce66a567ac1474cc7c755f57c0",
"md5": "d0c312c14823afad2c582a89072aae46",
"sha256": "fe7f0352d72845a6e4a22f7e61dda295594bdebb40eae669968b3ea9916607b2"
},
"downloads": -1,
"filename": "vmod_geodesy-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d0c312c14823afad2c582a89072aae46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 55260,
"upload_time": "2024-08-25T21:03:55",
"upload_time_iso_8601": "2024-08-25T21:03:55.304102Z",
"url": "https://files.pythonhosted.org/packages/8e/fc/cb1b4b19d2d40bb4fa673d94f8481f466cce66a567ac1474cc7c755f57c0/vmod_geodesy-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 21:03:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uafgeotools",
"github_project": "vmod",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vmod-geodesy"
}
