# _pycsamt_: A package for audio-frequency magnetotellurics
[](https://pycsamt.readthedocs.io/en/latest/?badge=latest) [](https://travis-ci.com/WEgeophysics/pyCSAMT)
  [](https://doi.org/10.5281/zenodo.5674430)
[](https://badge.fury.io/py/pycsamt)
## Overview
* **Purpose**
Previously, the software was intended for controlled source audio-frequency magnetotelluric (CSAMT) data processing (hereinafter the suffix CSAMT) and mostly related
to the groundwater exploration. The recent development is focused on the audio-magnetotelluric(AMT) methods. Indeed, the AMT methods are used broadly in diverse of exploration problems such as mineral, hydrocarbon, groundwater resources, as well as the fault-zone mapping above the 1km depth.
_pycsamt_ is designed to bring a piece of solution to the problems encountered by using AMT methods. It contains steps of AMT data processing and deals with [OCCAM2D](https://marineemlab.ucsd.edu/Projects/Occam/index.html) of [DeGroot-Hedlin and Constable, 1990](https://doi.org/10.1190/1.1442303) ,
the [MT2DInvMatlab](https://doi.org/10.1016/j.cageo.2008.10.010) of [Lee et al., 2009](https://doi.org/10.1016/j.cageo.2008.10.010) and [ModEM](https://sites.google.com/site/modularem/download) of [Kelbert et al., 2014](https://doi.org/10.1016/j.cageo.2014.01.010)
for the modeling purpose.
It also provides processing tools for filtering and processing data( the trimming moving-average (MA), the fixed dipole-length MA ([Zonge International Engineering (Zonge, 2000)]( http://www.zonge.com/legacy/PDF_DatPro/Astatic.pdf )), the adaptative MA ( [Torres-verdìn and Bostick, 1992](https://doi.org/10.1190/1.2400625)). These filters are mostly used for fast removing the static effect especially in electromagnetic-array profiling survey. Some others filters such as "simple" for outliers removal and "PCA" can also be applied upstream for a particular data where the interferences are very strong (e.g. intenses humman activities, power lines, ...). Moreover, the "Savitzky-Golay" filter is also added to remove high-frequency noise from data since it has the advantage of preserving the original shape and features of the signal better than other types of filtering approaches such as MA techniques (simple, exponential, cumulative, weight).
* **Note**
For long periods or MT methods (below 1Hz), it is recommended to visit other suitable softwares such as [MTpy](https://github.com/MTgeophysics/mtpy.git), [FEMT2D](https://github.com/ruboerner/FEMT2D), [razorback](https://github.com/BRGM/razorback) or consult the [MTNet](https://www.mtnet.info/main/source.html) website. Nonetheless, the sofware has a feature to generate outputs/objects for other external modeling softwares such as [MTpy](https://github.com/MTgeophysics/mtpy), [OasisMontaj](http://updates.geosoft.com/downloads/files/how-to-guides/Oasis_montaj_Gridding.pdf) and [GoldenSoftware](https://www.goldensoftware.com/products/surfer).
## Documentation
* [Installation Guide](https://pycsamt.readthedocs.io/en/latest/installation.html?highlight=installation)
* [API Documentation](https://pycsamt.readthedocs.io/en/latest/)
* [Home Page](https://github.com/WEgeophysics/pyCSAMT/wiki)
* [User Guide](https://github.com/WEgeophysics/pyCSAMT/blob/develop/docs/pyCSAMT%20User%20Guide.pdf)
## Credits
We use or link some third-party software (beside the usual tool stack: [Numba](https://numba.pydata.org/), [Numpy](https://numpy.org/), [Scipy](https://scipy.org/), [SumPy](https://www.sympy.org/en/index.html), [Matplotlib](https://matplotlib.org/)) and are grateful for all the work made by the authors of these awesome open-source tools:
* [MTpy](https://github.com/MTgeophysics/mtpy.git)
* [Occam2D](https://marineemlab.ucsd.edu/Projects/Occam/index.html)
* [ModEM](https://sites.google.com/site/modularem/)
* Zonge Engineering softwares:
- [AMTAVG](http://www.zonge.com/legacy/DatPro.html/)
- [ASTATIC](http://www.zonge.com/legacy/PDF_DatPro/Astatic.pdf)
## System requirements
* Python 3.7+
## Citations
We'd much appreciate if you consider citing the toolbox as a contribution in a published work:
> *Kouadio, K.L., Liu, R., Mi, B., Liu, C., 2022. pyCSAMT: An alternative Python toolbox for groundwater exploration using controlled source audio-frequency magnetotelluric. J. Appl. Geophys. 201, 104647. https://doi.org/10.1016/j.jappgeo.2022.104647.*
>
A case study using the software can also be found in the paper below:
> *Kouadio, L. K., Liu, R., Malory, A. O., Liu, W., Liu, C., (2023). A novel approach for water reservoir mapping using controlled source audio - frequency magnetotelluric in Xingning area , Hunan Province, China. Geophys. Prospect., https://doi.org/10.1111/1365-2478.13385*
>
## Contributors
1. Department of Geophysics, School of Info-physics and Geomatics Engineering, [Central South University](https://en.csu.edu.cn/), China.
2. Equipe de Recherche Géophysique Appliquée, Laboratoire de Geologie Ressources Minerales et Energetiques, UFR des Sciences de la Terre et des Ressources Minières, [Université Félix Houphouët-Boigny]( https://www.univ-fhb.edu.ci/index.php/ufr-strm/), Cote d'Ivoire.
* Developer: 1, 2- Kouadio Laurent, <etanoyau@gmail.com> / <lkouao@csu.edu.cn>.
Raw data
{
"_id": null,
"home_page": "https://github.com/WEgeophysics/pyCSAMT",
"name": "pycsamt",
"maintainer": "Kouadio K. Laurent",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "etanoyau@gmail.com",
"keywords": "hydrogeophysic,groundwater,exploration,csamt",
"author": "Kouadio K. Laurent, Rong Liu, Binbin Mi, Chum-ning Liu, Albert O. Malory.",
"author_email": "kkouao@zju.edu.cn",
"download_url": "https://files.pythonhosted.org/packages/e7/97/85adbf304fc6c54c4ca45a8342094ad238c766dbecbc319aea6af0b01c5c/pycsamt-1.2.1.tar.gz",
"platform": null,
"description": "# _pycsamt_: A package for audio-frequency magnetotellurics\r\n\r\n[](https://pycsamt.readthedocs.io/en/latest/?badge=latest) [](https://travis-ci.com/WEgeophysics/pyCSAMT) \r\n   [](https://doi.org/10.5281/zenodo.5674430)\r\n [](https://badge.fury.io/py/pycsamt)\r\n\r\n## Overview \r\n\r\n * **Purpose**\r\n \r\n Previously, the software was intended for controlled source audio-frequency magnetotelluric (CSAMT) data processing (hereinafter the suffix CSAMT) and mostly related\r\n to the groundwater exploration. The recent development is focused on the audio-magnetotelluric(AMT) methods. Indeed, the AMT methods are used broadly in diverse of exploration problems such as mineral, hydrocarbon, groundwater resources, as well as the fault-zone mapping above the 1km depth. \r\n _pycsamt_ is designed to bring a piece of solution to the problems encountered by using AMT methods. It contains steps of AMT data processing and deals with [OCCAM2D](https://marineemlab.ucsd.edu/Projects/Occam/index.html) of [DeGroot-Hedlin and Constable, 1990](https://doi.org/10.1190/1.1442303) , \r\n the [MT2DInvMatlab](https://doi.org/10.1016/j.cageo.2008.10.010) of [Lee et al., 2009](https://doi.org/10.1016/j.cageo.2008.10.010) and [ModEM](https://sites.google.com/site/modularem/download) of [Kelbert et al., 2014](https://doi.org/10.1016/j.cageo.2014.01.010)\r\n for the modeling purpose.\r\n \r\n It also provides processing tools for filtering and processing data( the trimming moving-average (MA), the fixed dipole-length MA ([Zonge International Engineering (Zonge, 2000)]( http://www.zonge.com/legacy/PDF_DatPro/Astatic.pdf )), the adaptative MA ( [Torres-verd\u00c3\u00acn and Bostick, 1992](https://doi.org/10.1190/1.2400625)). These filters are mostly used for fast removing the static effect especially in electromagnetic-array profiling survey. Some others filters such as \"simple\" for outliers removal and \"PCA\" can also be applied upstream for a particular data where the interferences are very strong (e.g. intenses humman activities, power lines, ...). Moreover, the \"Savitzky-Golay\" filter is also added to remove high-frequency noise from data since it has the advantage of preserving the original shape and features of the signal better than other types of filtering approaches such as MA techniques (simple, exponential, cumulative, weight). \r\n \r\n * **Note**\r\n \r\n For long periods or MT methods (below 1Hz), it is recommended to visit other suitable softwares such as [MTpy](https://github.com/MTgeophysics/mtpy.git), [FEMT2D](https://github.com/ruboerner/FEMT2D), [razorback](https://github.com/BRGM/razorback) or consult the [MTNet](https://www.mtnet.info/main/source.html) website. Nonetheless, the sofware has a feature to generate outputs/objects for other external modeling softwares such as [MTpy](https://github.com/MTgeophysics/mtpy), [OasisMontaj](http://updates.geosoft.com/downloads/files/how-to-guides/Oasis_montaj_Gridding.pdf) and [GoldenSoftware](https://www.goldensoftware.com/products/surfer).\r\n\r\n\r\n## Documentation \r\n\r\n* [Installation Guide](https://pycsamt.readthedocs.io/en/latest/installation.html?highlight=installation)\r\n* [API Documentation](https://pycsamt.readthedocs.io/en/latest/)\r\n* [Home Page](https://github.com/WEgeophysics/pyCSAMT/wiki)\r\n* [User Guide](https://github.com/WEgeophysics/pyCSAMT/blob/develop/docs/pyCSAMT%20User%20Guide.pdf)\r\n\r\n## Credits\r\n\r\nWe use or link some third-party software (beside the usual tool stack: [Numba](https://numba.pydata.org/), [Numpy](https://numpy.org/), [Scipy](https://scipy.org/), [SumPy](https://www.sympy.org/en/index.html), [Matplotlib](https://matplotlib.org/)) and are grateful for all the work made by the authors of these awesome open-source tools:\r\n* [MTpy](https://github.com/MTgeophysics/mtpy.git)\r\n* [Occam2D](https://marineemlab.ucsd.edu/Projects/Occam/index.html)\r\n* [ModEM](https://sites.google.com/site/modularem/)\r\n* Zonge Engineering softwares:\r\n - [AMTAVG](http://www.zonge.com/legacy/DatPro.html/)\r\n - [ASTATIC](http://www.zonge.com/legacy/PDF_DatPro/Astatic.pdf)\r\n\r\n## System requirements \r\n\r\n* Python 3.7+ \r\n\r\n## Citations \r\n\r\n We'd much appreciate if you consider citing the toolbox as a contribution in a published work:\r\n\r\n> *Kouadio, K.L., Liu, R., Mi, B., Liu, C., 2022. pyCSAMT: An alternative Python toolbox for groundwater exploration using controlled source audio-frequency magnetotelluric. J. Appl. Geophys. 201, 104647. https://doi.org/10.1016/j.jappgeo.2022.104647.*\r\n> \r\n\r\nA case study using the software can also be found in the paper below: \r\n\r\n> *Kouadio, L. K., Liu, R., Malory, A. O., Liu, W., Liu, C., (2023). A novel approach for water reservoir mapping using controlled source audio - frequency magnetotelluric in Xingning area , Hunan Province, China. Geophys. Prospect., https://doi.org/10.1111/1365-2478.13385*\r\n>\r\n\r\n## Contributors\r\n\r\n1. Department of Geophysics, School of Info-physics and Geomatics Engineering, [Central South University](https://en.csu.edu.cn/), China. \r\n2. Equipe de Recherche G\u00c3\u00a9ophysique Appliqu\u00c3\u00a9e, Laboratoire de Geologie Ressources Minerales et Energetiques, UFR des Sciences de la Terre et des Ressources Mini\u00c3\u00a8res, [Universit\u00c3\u00a9 F\u00c3\u00a9lix Houphou\u00c3\u00abt-Boigny]( https://www.univ-fhb.edu.ci/index.php/ufr-strm/), Cote d'Ivoire.\r\n\r\n* Developer: 1, 2- Kouadio Laurent, <etanoyau@gmail.com> / <lkouao@csu.edu.cn>.\r\n",
"bugtrack_url": null,
"license": "GNU LESSER GENERAL PUBLIC LICENSE v3",
"summary": "A Python open-source toolkit Audio-frequency Magnetotelluric",
"version": "1.2.1",
"project_urls": {
"API Documentation": "https://pycsamt.readthedocs.io/en/master/",
"Bugs tracker": "https://github.com/WEgeophysics/pyCSAMT/issues",
"Home page": "https://github.com/WEgeophysics/pyCSAMT/wiki",
"Homepage": "https://github.com/WEgeophysics/pyCSAMT",
"Installation guide": "https://github.com/WEgeophysics/pyCSAMT/wiki/pyCSAMT-installation-guide-for-Windows--and-Linux",
"User guide": "https://github.com/WEgeophysics/pyCSAMT/blob/develop/docs/pyCSAMT%20User%20Guide.pdf"
},
"split_keywords": [
"hydrogeophysic",
"groundwater",
"exploration",
"csamt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "026fcf5b50075b4c37dc1f5909a62d51ee8d8bc77ea3d927c8a05b4a00c143fd",
"md5": "b14776a2345cd394ede2bd08818e386f",
"sha256": "4bcf37825c75f850e7e5af8299881c47956f31928ec40e3c5dc8014ac4f2372d"
},
"downloads": -1,
"filename": "pycsamt-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b14776a2345cd394ede2bd08818e386f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 768144,
"upload_time": "2023-07-09T08:04:10",
"upload_time_iso_8601": "2023-07-09T08:04:10.506899Z",
"url": "https://files.pythonhosted.org/packages/02/6f/cf5b50075b4c37dc1f5909a62d51ee8d8bc77ea3d927c8a05b4a00c143fd/pycsamt-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e79785adbf304fc6c54c4ca45a8342094ad238c766dbecbc319aea6af0b01c5c",
"md5": "f58fbc1a8fb00d3b6d73aac6a16c1fdf",
"sha256": "0acb1777c03fd2284eec803d94bb11d0748963e563ef78207c32ced23a3c93eb"
},
"downloads": -1,
"filename": "pycsamt-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "f58fbc1a8fb00d3b6d73aac6a16c1fdf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3364338,
"upload_time": "2023-07-09T08:04:13",
"upload_time_iso_8601": "2023-07-09T08:04:13.648397Z",
"url": "https://files.pythonhosted.org/packages/e7/97/85adbf304fc6c54c4ca45a8342094ad238c766dbecbc319aea6af0b01c5c/pycsamt-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 08:04:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WEgeophysics",
"github_project": "pyCSAMT",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "sphinx",
"specs": [
[
">=",
"3.8"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.3.0"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "qtpy",
"specs": []
},
{
"name": "netcdf4",
"specs": []
},
{
"name": "numpydoc",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "pytest",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "pyproj",
"specs": [
[
">=",
"1.9.6"
]
]
},
{
"name": "pandas",
"specs": []
},
{
"name": "python-coveralls",
"specs": []
},
{
"name": "tqdm",
"specs": []
},
{
"name": "mtpy",
"specs": []
},
{
"name": "geopandas",
"specs": []
},
{
"name": "joblib",
"specs": []
}
],
"lcname": "pycsamt"
}
JSON
