Name | pyexafs JSON |
Version |
1.0.0b9
JSON |
| download |
home_page | None |
Summary | A simple package for fast analysis of EXAFS data |
upload_time | 2024-06-28 18:07:07 |
maintainer | None |
docs_url | None |
author | None |
requires_python | None |
license | MIT License Copyright (c) [2022-2024] [FRANK FÖRSTE, SEBASTIAN PARIPSA] 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. |
keywords |
research-and-development
exafs
data-science
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# PyEXAFS
[![Test Status](https://github.com/San-WierPa/pyexafs/workflows/Test/badge.svg?branch=main)](https://github.com/San-WierPa/pyexafs/actions?query=workflow%3ATest)
[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![imports: isort](https://img.shields.io/badge/imports-isort-ef8336.svg)](https://github.com/PyCQA/isort)
Developed by Frank Foerste and Sebastian Paripsa, **PyExafs** aims to streamline the workflow<br>
for XAS researchers, from data acquisition to final analysis.
## Introduction
**PyExafs** is designed to facilitate the automated quality assessment<br>
of X-ray Absorption Fine Structure (XAFS) measurements. Leveraging the robust capabilities of the Larch library,<br>
**PyExafs** enables researchers to efficiently process, analyse, and visualise XAFS data, ensuring adherence to stringent quality criteria.
With a single execution, **PyExafs** provides a fast analysis of a dataset, instantly delivering:
+ Absorbance
+ Normalized Absorbance
+ $\chi(k)$
+ $\chi(R)$
These results are presented according to well-defined quality standards, enabling users to quickly evaluate<br>
the integrity of their data.
Key features include:
+ Automated Quality Control: Implements rigorous routines to verify the quality of XAFS measurements.
+ Data Preprocessing: Efficiently handles data loading, preprocessing, and energy calibration.
+ Visualisation: Generates comprehensive plots for raw, normalized, k-space, and R-space data,<br>
supporting both detailed analysis and publication-quality figures.
+ Noise Estimation and Fitting: Provides tools for estimating noise and fitting the first shell,<br>
crucial for accurate data interpretation.
## Installation
Easy:
```sh
python -m pip install pyexafs
```
## Usage
To use the `pyexafs` package, run the following command and provide the path to your data file:
```sh
python -m pyexafs <path_to_data_file>
```
For example:
```sh
python -m pyexafs /path/to/your/datafile.txt
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pyexafs",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "research-and-development, exafs, data-science",
"author": null,
"author_email": "Sebastian Paripsa <paripsa@uni-wuppertal.de>",
"download_url": "https://files.pythonhosted.org/packages/80/52/2aa7b2303b78482f2972997c4b2bbeaf49cf2acfd136dc7d5982b59f9f99/pyexafs-1.0.0b9.tar.gz",
"platform": null,
"description": "# PyEXAFS\n\n[![Test Status](https://github.com/San-WierPa/pyexafs/workflows/Test/badge.svg?branch=main)](https://github.com/San-WierPa/pyexafs/actions?query=workflow%3ATest)\n[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![imports: isort](https://img.shields.io/badge/imports-isort-ef8336.svg)](https://github.com/PyCQA/isort)\n\nDeveloped by Frank Foerste and Sebastian Paripsa, **PyExafs** aims to streamline the workflow<br>\nfor XAS researchers, from data acquisition to final analysis.\n\n## Introduction\n\n**PyExafs** is designed to facilitate the automated quality assessment<br>\nof X-ray Absorption Fine Structure (XAFS) measurements. Leveraging the robust capabilities of the Larch library,<br>\n**PyExafs** enables researchers to efficiently process, analyse, and visualise XAFS data, ensuring adherence to stringent quality criteria.\n\nWith a single execution, **PyExafs** provides a fast analysis of a dataset, instantly delivering:\n\n+ Absorbance\n+ Normalized Absorbance\n+ $\\chi(k)$\n+ $\\chi(R)$\n\nThese results are presented according to well-defined quality standards, enabling users to quickly evaluate<br>\nthe integrity of their data.\n\nKey features include:\n\n+ Automated Quality Control: Implements rigorous routines to verify the quality of XAFS measurements.\n+ Data Preprocessing: Efficiently handles data loading, preprocessing, and energy calibration.\n+ Visualisation: Generates comprehensive plots for raw, normalized, k-space, and R-space data,<br>\nsupporting both detailed analysis and publication-quality figures.\n+ Noise Estimation and Fitting: Provides tools for estimating noise and fitting the first shell,<br>\ncrucial for accurate data interpretation.\n\n## Installation\n\nEasy:\n\n```sh\npython -m pip install pyexafs\n```\n\n## Usage\n\nTo use the `pyexafs` package, run the following command and provide the path to your data file:\n\n```sh\npython -m pyexafs <path_to_data_file>\n```\n\nFor example:\n\n```sh\npython -m pyexafs /path/to/your/datafile.txt\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2022-2024] [FRANK F\u00d6RSTE, SEBASTIAN PARIPSA] 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. ",
"summary": "A simple package for fast analysis of EXAFS data",
"version": "1.0.0b9",
"project_urls": {
"Homepage": "https://github.com/San-WierPa/pyexafs"
},
"split_keywords": [
"research-and-development",
" exafs",
" data-science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "24902b0ab14249133027ad0166e598919991112e8e84b8ca13fc8672ad993c8a",
"md5": "d30316cd00d1c5e9d7911c334e835ba6",
"sha256": "fccfd5aaf74745cf9c8bc1f42c0949988420817d9b297666eb6fa1fbc6ececf6"
},
"downloads": -1,
"filename": "pyexafs-1.0.0b9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d30316cd00d1c5e9d7911c334e835ba6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 329671,
"upload_time": "2024-06-28T18:07:05",
"upload_time_iso_8601": "2024-06-28T18:07:05.785357Z",
"url": "https://files.pythonhosted.org/packages/24/90/2b0ab14249133027ad0166e598919991112e8e84b8ca13fc8672ad993c8a/pyexafs-1.0.0b9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80522aa7b2303b78482f2972997c4b2bbeaf49cf2acfd136dc7d5982b59f9f99",
"md5": "c875ed47c9ecb6eabfbdb9993c336745",
"sha256": "645373be13b6765014b2905d3211544582b1b0da0d15a2836b9b80a7441ea460"
},
"downloads": -1,
"filename": "pyexafs-1.0.0b9.tar.gz",
"has_sig": false,
"md5_digest": "c875ed47c9ecb6eabfbdb9993c336745",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 332766,
"upload_time": "2024-06-28T18:07:07",
"upload_time_iso_8601": "2024-06-28T18:07:07.778684Z",
"url": "https://files.pythonhosted.org/packages/80/52/2aa7b2303b78482f2972997c4b2bbeaf49cf2acfd136dc7d5982b59f9f99/pyexafs-1.0.0b9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 18:07:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "San-WierPa",
"github_project": "pyexafs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyexafs"
}