| Name | fracspy JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A python package for general microseismic modelling, monitoring and analysis |
| upload_time | 2024-10-11 12:57:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
geophysics
signal processing
microseismic
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FraCSPy
[](https://zenodo.org/badge/latestdoi/619447827)
FraCSPy stands for Python Framework for Conventional microSeismic Processing.
It is a single python toolbox for the full microseismic pipeline from modelling to post-event analysis.
This library is a single location leveraging the excellent work of other scientists (software developers) and adapts them for the specific use case of microseismic monitoring.
Some functionalities include:
- modelling script generation (for accompanying [SOFI3D](https://docs.csc.fi/apps/sofi3d/))
- event imaging: detection, location
- moment tensor inversion
Some python libraries that are utilised include:
- pylops
- torch
- obspy
- and more...
## Requirements
Installation requires either [pip](https://pypi.org/project/pip/) package installer or [Conda](https://conda.io) package manager, e.g. one can use [miniforge](https://github.com/conda-forge/miniforge).
## Install using pip
```bash
pip install fracspy
```
## Install using conda
### Linux
Simply run
```bash
make install
```
It will create a new conda environment `fracspy` with all the required packages:
Similarly, on Linux you can run:
```bash
./install.sh
```
### Windows
On Windows, the best way is to use [miniforge](https://github.com/conda-forge/miniforge) prompt and run:
```cmd
install.bat
```
It will install the package to environment `fracspy` and activate it.
To install development version use
```cmd
install-dev.bat
```
Now you are ready to use the package.
### Uninstall
If you need to add/change packages:
```bash
conda deactivate
conda remove -n fracspy -all
```
## Documentation
The latest stable documentation based on [Sphinx](https://www.sphinx-doc.org) is available online at: <https://fracspy.github.io/FraCSPy>
One can also build the documentation locally:
```bash
cd docs
make html
```
If you want to rebuild the documentation:
```bash
make clean
make html
```
After a successful build, one can serve the documentation website locally:
```bash
cd build/html
python -m http.server
```
and open in browser: <http://localhost:8000>
To build/rebuild documentation on Windows you can simply run
```cmd
build_docs.bat
```
**Note:** check the exact port number in the output
Raw data
{
"_id": null,
"home_page": null,
"name": "fracspy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "geophysics, signal processing, microseismic",
"author": null,
"author_email": "Claire Emma Birnie <claire.birnie@kaust.edu.sa>, Denis Anikiev <denis.anikiev@gfz-potsdam.de>, Omar Sad Aly <omar.sadaly@kaust.edu.sa>, Matteo Ravasi <matteo.ravasi@kaust.edu.sa>",
"download_url": "https://files.pythonhosted.org/packages/f3/2d/d15a16c9cedef77abc5a4af8dc9695ae8e72fe39102a792ec97b707a192a/fracspy-0.1.0.tar.gz",
"platform": null,
"description": "# FraCSPy\n\n[](https://zenodo.org/badge/latestdoi/619447827)\n\nFraCSPy stands for Python Framework for Conventional microSeismic Processing.\n\n\n\nIt is a single python toolbox for the full microseismic pipeline from modelling to post-event analysis.\nThis library is a single location leveraging the excellent work of other scientists (software developers) and adapts them for the specific use case of microseismic monitoring.\n\nSome functionalities include:\n\n- modelling script generation (for accompanying [SOFI3D](https://docs.csc.fi/apps/sofi3d/))\n- event imaging: detection, location\n- moment tensor inversion\n\nSome python libraries that are utilised include:\n\n- pylops\n- torch\n- obspy\n- and more...\n\n## Requirements\n\nInstallation requires either [pip](https://pypi.org/project/pip/) package installer or [Conda](https://conda.io) package manager, e.g. one can use [miniforge](https://github.com/conda-forge/miniforge).\n\n## Install using pip\n\n```bash\npip install fracspy\n```\n\n## Install using conda\n\n### Linux\n\nSimply run\n\n```bash\nmake install\n```\n\nIt will create a new conda environment `fracspy` with all the required packages:\n\nSimilarly, on Linux you can run:\n\n```bash\n./install.sh\n```\n\n### Windows\n\nOn Windows, the best way is to use [miniforge](https://github.com/conda-forge/miniforge) prompt and run:\n\n```cmd\ninstall.bat\n```\n\nIt will install the package to environment `fracspy` and activate it.\n\nTo install development version use\n\n```cmd\ninstall-dev.bat\n```\n\nNow you are ready to use the package.\n\n### Uninstall\n\nIf you need to add/change packages:\n\n```bash\nconda deactivate\nconda remove -n fracspy -all\n```\n\n## Documentation\n\nThe latest stable documentation based on [Sphinx](https://www.sphinx-doc.org) is available online at: <https://fracspy.github.io/FraCSPy>\n\nOne can also build the documentation locally:\n\n```bash\ncd docs\nmake html\n```\n\nIf you want to rebuild the documentation:\n\n```bash\nmake clean\nmake html\n```\n\nAfter a successful build, one can serve the documentation website locally:\n\n```bash\ncd build/html\npython -m http.server\n```\n\nand open in browser: <http://localhost:8000>\n\nTo build/rebuild documentation on Windows you can simply run\n\n```cmd\nbuild_docs.bat\n```\n\n**Note:** check the exact port number in the output\n",
"bugtrack_url": null,
"license": null,
"summary": "A python package for general microseismic modelling, monitoring and analysis",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"geophysics",
" signal processing",
" microseismic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b90cafc9ee74f86dfd7e77c00793756c7f4b4aced5e52fd7612b423559f1ab8",
"md5": "5a70f51977b4ac4353bdd7682d67dcb8",
"sha256": "2c07c868acf7c7d4d5f4536dbc01ed0b41b4fdd33d811ec7e94d5e76dd7f51ca"
},
"downloads": -1,
"filename": "fracspy-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a70f51977b4ac4353bdd7682d67dcb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 66710,
"upload_time": "2024-10-11T12:57:54",
"upload_time_iso_8601": "2024-10-11T12:57:54.797348Z",
"url": "https://files.pythonhosted.org/packages/9b/90/cafc9ee74f86dfd7e77c00793756c7f4b4aced5e52fd7612b423559f1ab8/fracspy-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f32dd15a16c9cedef77abc5a4af8dc9695ae8e72fe39102a792ec97b707a192a",
"md5": "60e715a09398df42cd2d2fc27725c6d4",
"sha256": "4842a650214faf7f8816e09e2b49c7ca9a1bf234b63a51af27502dd968ce1651"
},
"downloads": -1,
"filename": "fracspy-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "60e715a09398df42cd2d2fc27725c6d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56609,
"upload_time": "2024-10-11T12:57:56",
"upload_time_iso_8601": "2024-10-11T12:57:56.482110Z",
"url": "https://files.pythonhosted.org/packages/f3/2d/d15a16c9cedef77abc5a4af8dc9695ae8e72fe39102a792ec97b707a192a/fracspy-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 12:57:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fracspy"
}
