Metadata-Version: 2.1
Name: PyFWI
Version: 0.1.5
Summary: The initial package for seismic FWI
Home-page: https://github.com/AmirMardan/PyFWI
Author: Amir Mardan
Author-email: mardan.ah69@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/AmirMardan/PyFWI/issues
Platform: UNKNOWN
Classifier: Intended Audience :: Education
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# PyFWI
[![PyPI version](https://badge.fury.io/py/PyFWI.svg)](https://badge.fury.io/py/PyFWI)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Documentation Status](https://readthedocs.org/projects/pyfwi/badge/?version=latest)](https://pyfwi.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/402170735.svg)](https://zenodo.org/badge/latestdoi/402170735)
[![Downloads](https://static.pepy.tech/personalized-badge/pyfwi?period=total&units=none&left_color=grey&right_color=green&left_text=Downloads)](https://pepy.tech/project/pyfwi)

This repository contains Python package for elastic seismic full-waveform inversion (FWI).

## Installation
To install this package, run 
```
python3 -m pip install PyFWI
```
on OS or 
```
py -m pip install PyFWI
```
on Windows.

## Citing PyFWI
```
@software{PyFWI,
  author       = {Mardan Amir and
                  Bernard Giroux and
                  Gabriel Fabien-Ouellet},
  title        = {{PyFWI}: {Python} Python package for Full-Waveform Inversion (FWI)},
  month        = Jan,
  year         = 2022,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.5813637},
  url          = {https://doi.org/10.5281/zenodo.5813637}
}
```


