Metadata-Version: 2.1
Name: bezpy
Version: 0.1.1
Summary: Geomagnetic field (B), Geoelectric field (E), and Magnetotelluric Impedance (Z) Python routines.
Author: Greg Lucas
License: Copyright (c) 2017 Greg Lucas
        
        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.
        
Project-URL: homepage, https://github.com/greglucas/bezpy
Keywords: geomagnetic,geoelectric,GIC,hazard analysis
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Matplotlib
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: AIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.21
Requires-Dist: pandas>=1.3
Requires-Dist: scipy>=1.7
Requires-Dist: shapely>=1.7
Provides-Extra: plotting
Requires-Dist: matplotlib>=3.4; extra == "plotting"

# Bezpy

[![DOI](https://zenodo.org/badge/115665136.svg)](https://zenodo.org/badge/latestdoi/115665136)

Bezpy is an open source library for analysis of geomagnetic (B), geoelectric (E),
and magnetotelluric impedance (Z) data within a geophysical framework.
This library contains routines for calculating the geoelectric field from the geomagnetic field in
multiple different ways.

## Features

- Geomagnetic to geoelectric field calculations
- Integration of the geoelectric field along transmission lines
- Built using established, fast, open source python libraries
    [Pandas](http://www.pandas.pydata.org/),
    [NumPy](http://www.numpy.org/),
    [SciPy](http://www.scipy.org/)

## Examples

Example notebooks can be found in [notebooks/](./notebooks/)

Example scripts for command line use can be found in [scripts/](./scripts/)

## Install

The easiest method to install bezpy is directly from PyPI using pip.

```bash
pip install bezpy
```

If you want a local install to modify anything in the code, you
can clone the git repository and install locally with these commands.

```bash
git clone https://github.com/greglucas/bezpy
cd bezpy
pip install .
```

## License

The code is released under the MIT license
[License described in LICENSE.md](./LICENSE.md)

## References

This package has been developed from different publications. Please consider citing the papers
that are relevant to the work you are doing if you are utilizing this code. The culmination of much of the work was contained in our paper
"A 100-year geoelectric hazard analysis for the U.S. high-voltage power grid."

[doi:10.1029/2019SW002329](https://doi.org/10.1029/2019SW002329)

```bibtex
Lucas, G., Love, J. J., Kelbert, A., Bedrosian, P. A., & Rigler, E. J. (2020).
A 100-year geoelectric hazard analysis for the U.S. high-voltage power grid.
Space Weather, 18, e2019SW002329.
https://doi.org/10.1029/2019SW002329
```

### Geoelectric field calculations

[doi:10.1002/2017GL076042](https://doi.org/10.1002/2017GL076042)

```bibtex
Love, J. J., Lucas, G. M., Kelbert, A., & Bedrosian, P. A. (2018).
Geoelectric hazard maps for the Mid‐Atlantic United States:
100 year extreme values and the 1989 magnetic storm.
Geophysical Research Letters, 44, doi:10.1002/2017GL076042.
```

### Transmission line integrations

[doi:10.1002/2017SW001779](https://doi.org/10.1002/2017SW001779)

```bibtex
Lucas, G. M., Love, J. J., & Kelbert, A. (2018). Calculation of voltages
in electric power transmission lines during historic geomagnetic storms:
An investigation using realistic earth impedances. Space Weather, 16,
181–195, doi:10.1002/2017SW001779.
```

### Time domain (DTIR)

[doi:10.1002/2017SW001594](https://doi.org/10.1002/2017SW001594)

```bibtex
Kelbert, A., C. C. Balch, A. Pulkkinen, G. D. Egbert,
J. J. Love, E. J. Rigler, and I. Fujii (2017),
Methodology for time-domain estimation of storm time geoelectric fields
using the 3-D magnetotelluric response tensors,
Space Weather, 15, 874–894, doi:10.1002/2017SW001594.
```

## Earthscope impedance database

[doi:10.17611/DP/EMTF.1](https://doi.org/10.17611/DP/EMTF.1)

```bibtex
Kelbert, A., G.D. Egbert and A. Schultz (2011),
IRIS DMC Data Services Products: EMTF, The Magnetotelluric Transfer Functions,
doi:10.17611/DP/EMTF.1.
```

## Problems/Questions

- [Report an issue using the GitHub issue tracker](http://github.com/greglucas/bezpy/issues)

## Additional Links

- [USGS Geomagnetism Program Home Page](https://geomag.usgs.gov/)
- [Real-time geoelectric field plots using bezpy](https://swx-trec.com/geoelectric)
