# Bayesian Earthquake Analysis Tool
Documentation of the current version moved to the pyrocko server can be found here:
https://pyrocko.org/beat/
Based on pyrocko, pytensor and pymc
## News
The new BEAT v2.0.0 is not backward compatible with project setups from BEAT v1.x.x!
## Tutorials
Step by step points on how to use the tool for several scenarios can be found here:
[Examples](https://pyrocko.org/beat/docs/current/examples/index.html#)
## Citation
If your work results in an publication where you used BEAT we kindly ask you to consider citing the BEAT software package and the related article.:
> Vasyura-Bathke, Hannes; Dettmer, Jan; Steinberg, Andreas; Heimann, Sebastian; Isken, Marius; Zielke, Olaf; Mai, Paul Martin; Sudhaus, Henriette; Jónsson, Sigurjón: The Bayesian Earthquake Analysis Tool. Seismological Research Letters. https://doi.org/10.1785/0220190075
> Vasyura-Bathke, Hannes; Dettmer, Jan; Steinberg, Andreas; Heimann, Sebastian; Isken, Marius; Zielke, Olaf; Mai, Paul Martin; Sudhaus, Henriette; Jónsson, Sigurjón (2019): BEAT - Bayesian Earthquake Analysis Tool. V. 1.0. GFZ Data Services. http://doi.org/10.5880/fidgeo.2019.024
## Support
For substantial issues please use and check the "issues" tab here in the repository.
For common issues please check out the BEAT [FAQ](https://pyrocko.org/beat/docs/current/faq.html).
For smaller issues or short clarifications there is a support [chat](https://hive.pyrocko.org/pyrocko-support/channels/beat). This is provided by the pyrocko project and is accessible after a short account creation.
Finally, there is the option to write an email to:
Hannes Vasyura-Bathke
hvasbath@uni-potsdam.de
Andreas Steinberg
andreas.steinberg@ifg.uni-kiel.de
**HELP wanted!**
The new release contains a lot of undocumented features a list of these can be found here:
https://github.com/hvasbath/beat/issues/69
However, as this project is mostly the work of a single author it is becoming increasingly difficult to also
write extended pages of tutorials that take days and days of writing. However, as this work is not acknowledged by the
current academic system, I had to decide for a delayed release of the documentation, whenever it will
be available provided by someone. Thus, in case you are willing to contribute I would be more than happy to guide/ support
you in writing parts of the documentation for a particular feature-if you want to try it out.
## License
GNU General Public License, Version 3, 29 June 2007
Copyright © 2017 Hannes Vasyura-Bathke
BEAT is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
BEAT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
## Data import
### Geodetic
We recommend to prepare the SAR data (subsampling, data covariance estimation) using KITE (www.pyrocko.org).
kite supports import of ISCE, GAMMA, ROI_Pac and GMTSAR processed interferograms. BEAT then supports import of the native KITE format.
### Seismic
To see a list of the supported data types please see: [Trace Handling](https://pyrocko.org/docs/current/library/examples/trace_handling.html)
In addition to these an ascii text file with the station information is needed of the format::
#network_name.station_name.location_name latitude[deg] longitude[deg] elevation[m] depth[m]
IU.TSUM.10 -19.20220 17.58380 1260.0 0.0
BHE 90 0 1 # channel name azimuth[deg] dip[deg] gain \n
BHN 0 0 1
BHZ 0 -90 1
IU.RCBR.00 -5.82740 -35.90140 291.0 109.0
BH1 48 0 1
BH2 138 0 1
BHZ 0 -90 1
...
To ease the creation of this textfile we refer the user to investigate the pyrocko module: model (Function: dump_stations)
In addition to these, BEAT supports the output of the autokiwi package.
Work is in progress to support obspy saved stream and inventory files, as well as stationxml stay tuned ...
Alternatively the seismic data may be saved using the package "pickle" as a file "seismic_data.pkl"
containing a list of 2 lists:
1. list of "pyrocko.trace.Trace" objects alternating for (Z / T / R) rotated traces.
2. list of "pyrocko.model.Station" objects in the same order like the data traces.
We invite the users to propose data formats or outputs of specific programs that they would
like to see implemented.
P.S.: If you came looking for the beat package calculating internet time you can find it [here](https://github.com/tonyskapunk/beat).
## Contributions
This is an open source project and contributions to the repository are welcome!
Raw data
{
"_id": null,
"home_page": null,
"name": "beat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Hannes Vasyura-Bathke <vasbath@gfz-potsdam.de>",
"keywords": "Bayesian Inference, seismology, geodesy, earthquake, volcano",
"author": null,
"author_email": "Hannes Vasyura-Bathke <vasbath@gfz-potsdam.de>",
"download_url": "https://files.pythonhosted.org/packages/e5/49/6a20a84a1a70df4a436468a79c2226c1cdc75d859f5ec2fe91aff64f9eb1/beat-2.0.3.tar.gz",
"platform": null,
"description": "\n\n\n# Bayesian Earthquake Analysis Tool\n\nDocumentation of the current version moved to the pyrocko server can be found here:\nhttps://pyrocko.org/beat/\n\nBased on pyrocko, pytensor and pymc\n\n## News\nThe new BEAT v2.0.0 is not backward compatible with project setups from BEAT v1.x.x!\n\n## Tutorials\nStep by step points on how to use the tool for several scenarios can be found here:\n[Examples](https://pyrocko.org/beat/docs/current/examples/index.html#)\n\n## Citation\nIf your work results in an publication where you used BEAT we kindly ask you to consider citing the BEAT software package and the related article.:\n\n > Vasyura-Bathke, Hannes; Dettmer, Jan; Steinberg, Andreas; Heimann, Sebastian; Isken, Marius; Zielke, Olaf; Mai, Paul Martin; Sudhaus, Henriette; J\u00f3nsson, Sigurj\u00f3n: The Bayesian Earthquake Analysis Tool. Seismological Research Letters. https://doi.org/10.1785/0220190075\n\n > Vasyura-Bathke, Hannes; Dettmer, Jan; Steinberg, Andreas; Heimann, Sebastian; Isken, Marius; Zielke, Olaf; Mai, Paul Martin; Sudhaus, Henriette; J\u00f3nsson, Sigurj\u00f3n (2019): BEAT - Bayesian Earthquake Analysis Tool. V. 1.0. GFZ Data Services. http://doi.org/10.5880/fidgeo.2019.024\n\n\n## Support\nFor substantial issues please use and check the \"issues\" tab here in the repository.\nFor common issues please check out the BEAT [FAQ](https://pyrocko.org/beat/docs/current/faq.html).\nFor smaller issues or short clarifications there is a support [chat](https://hive.pyrocko.org/pyrocko-support/channels/beat). This is provided by the pyrocko project and is accessible after a short account creation.\n\nFinally, there is the option to write an email to:\n\nHannes Vasyura-Bathke\nhvasbath@uni-potsdam.de\n\nAndreas Steinberg\nandreas.steinberg@ifg.uni-kiel.de\n\n**HELP wanted!**\n\nThe new release contains a lot of undocumented features a list of these can be found here:\nhttps://github.com/hvasbath/beat/issues/69\nHowever, as this project is mostly the work of a single author it is becoming increasingly difficult to also\nwrite extended pages of tutorials that take days and days of writing. However, as this work is not acknowledged by the\ncurrent academic system, I had to decide for a delayed release of the documentation, whenever it will\nbe available provided by someone. Thus, in case you are willing to contribute I would be more than happy to guide/ support\nyou in writing parts of the documentation for a particular feature-if you want to try it out.\n\n## License\nGNU General Public License, Version 3, 29 June 2007\n\nCopyright \u00a9 2017 Hannes Vasyura-Bathke\n\nBEAT is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\nBEAT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\nYou should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.\n\n\n## Data import\n### Geodetic\nWe recommend to prepare the SAR data (subsampling, data covariance estimation) using KITE (www.pyrocko.org).\nkite supports import of ISCE, GAMMA, ROI_Pac and GMTSAR processed interferograms. BEAT then supports import of the native KITE format.\n\n### Seismic\nTo see a list of the supported data types please see: [Trace Handling](https://pyrocko.org/docs/current/library/examples/trace_handling.html)\nIn addition to these an ascii text file with the station information is needed of the format::\n\n #network_name.station_name.location_name latitude[deg] longitude[deg] elevation[m] depth[m]\n IU.TSUM.10 -19.20220 17.58380 1260.0 0.0\n BHE 90 0 1 # channel name azimuth[deg] dip[deg] gain \\n\n BHN 0 0 1\n BHZ 0 -90 1\n IU.RCBR.00 -5.82740 -35.90140 291.0 109.0\n BH1 48 0 1\n BH2 138 0 1\n BHZ 0 -90 1\n ...\n\nTo ease the creation of this textfile we refer the user to investigate the pyrocko module: model (Function: dump_stations)\n\nIn addition to these, BEAT supports the output of the autokiwi package.\n\nWork is in progress to support obspy saved stream and inventory files, as well as stationxml stay tuned ...\n\nAlternatively the seismic data may be saved using the package \"pickle\" as a file \"seismic_data.pkl\"\ncontaining a list of 2 lists:\n1. list of \"pyrocko.trace.Trace\" objects alternating for (Z / T / R) rotated traces.\n2. list of \"pyrocko.model.Station\" objects in the same order like the data traces.\n\nWe invite the users to propose data formats or outputs of specific programs that they would\nlike to see implemented.\n\nP.S.: If you came looking for the beat package calculating internet time you can find it [here](https://github.com/tonyskapunk/beat).\n\n## Contributions\nThis is an open source project and contributions to the repository are welcome!\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "'Bayesian Earthquake Analysis Tool'",
"version": "2.0.3",
"project_urls": {
"GitHub": "https://github.com/hvasbath/beat",
"Home": "https://pyrocko.org/beat",
"Issues": "https://github.com/hvasbath/beat/issues"
},
"split_keywords": [
"bayesian inference",
" seismology",
" geodesy",
" earthquake",
" volcano"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5496a20a84a1a70df4a436468a79c2226c1cdc75d859f5ec2fe91aff64f9eb1",
"md5": "aaa4deaf04c6cc4570a73c12f63c441f",
"sha256": "b1bff070ebdc48f6f5d830bc52d37d73ec12e1e798a9ddc950068a779f413baf"
},
"downloads": -1,
"filename": "beat-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "aaa4deaf04c6cc4570a73c12f63c441f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 308994,
"upload_time": "2024-09-28T22:32:45",
"upload_time_iso_8601": "2024-09-28T22:32:45.873930Z",
"url": "https://files.pythonhosted.org/packages/e5/49/6a20a84a1a70df4a436468a79c2226c1cdc75d859f5ec2fe91aff64f9eb1/beat-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-28 22:32:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hvasbath",
"github_project": "beat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "beat"
}
JSON
