<h1 align="center">ARPES Python Tools</h1>
<p align="center">
<a href="https://github.com/pranabdas/arpespythontools/actions/workflows/python-tests.yml"><img src="https://github.com/pranabdas/arpespythontools/actions/workflows/python-tests.yml/badge.svg" alt="Python tests status"></a>
<a href="https://github.com/pranabdas/arpespythontools/actions/workflows/deploy-gh-pages.yml"><img src="https://github.com/pranabdas/arpespythontools/actions/workflows/deploy-gh-pages.yml/badge.svg" alt="Deploy gh-pages status"></a>
<a href="https://github.com/pranabdas/arpespythontools/actions/workflows/publish.yml"><img src="https://github.com/pranabdas/arpespythontools/actions/workflows/publish.yml/badge.svg" alt="Deploy gh-pages status"></a>
<a href="https://github.com/pranabdas/arpespythontools/blob/master/LICENSE"><img src="https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=A31F34"></a>
<a href="https://pypi.org/project/arpespythontools/"><img src="https://img.shields.io/github/v/release/pranabdas/arpespythontools.svg" alt="Latest Release"/></a>
</p>
This python library helps you load, analyze and visualize ARPES data.
## Quick start
Install latest stable version:
```console
pip install --upgrade arpespythontools
```
Import and start using:
```python
import arpespythontools as arp
data, energy, angle = arp.load_ses_spectra("sample_spectrum.txt")
data_k, e_bin, k = arp.k_conv(data, energy, angle, 16.67)
```
Please find the detailed documentation here:
<https://pranabdas.github.io/arpespythontools/>
## Development
Clone repository:
```console
git clone https://github.com/pranabdas/arpespythontools
```
Install project in editable mode:
```console
pip install -e .
```
Run tests locally:
```console
python3 -m unittest discover tests
```
Raw data
{
"_id": null,
"home_page": "https://pranabdas.github.io/arpespythontools/",
"name": "arpespythontools",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "python, data-analysis, matplotlib, materials-science, surface-science, condensed-matter-physics, photoelectron-spectroscopy, arpes",
"author": "Pranab Das",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b0/99/d1487af3db96e69651c154671b61301f1ce1e5c777a22a407828b33afea5/arpespythontools-1.0.3.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">ARPES Python Tools</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/pranabdas/arpespythontools/actions/workflows/python-tests.yml\"><img src=\"https://github.com/pranabdas/arpespythontools/actions/workflows/python-tests.yml/badge.svg\" alt=\"Python tests status\"></a>\n <a href=\"https://github.com/pranabdas/arpespythontools/actions/workflows/deploy-gh-pages.yml\"><img src=\"https://github.com/pranabdas/arpespythontools/actions/workflows/deploy-gh-pages.yml/badge.svg\" alt=\"Deploy gh-pages status\"></a>\n <a href=\"https://github.com/pranabdas/arpespythontools/actions/workflows/publish.yml\"><img src=\"https://github.com/pranabdas/arpespythontools/actions/workflows/publish.yml/badge.svg\" alt=\"Deploy gh-pages status\"></a>\n <a href=\"https://github.com/pranabdas/arpespythontools/blob/master/LICENSE\"><img src=\"https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=A31F34\"></a>\n <a href=\"https://pypi.org/project/arpespythontools/\"><img src=\"https://img.shields.io/github/v/release/pranabdas/arpespythontools.svg\" alt=\"Latest Release\"/></a>\n</p>\n\nThis python library helps you load, analyze and visualize ARPES data.\n\n## Quick start\n\nInstall latest stable version:\n```console\npip install --upgrade arpespythontools\n```\n\nImport and start using:\n\n```python\nimport arpespythontools as arp\n\ndata, energy, angle = arp.load_ses_spectra(\"sample_spectrum.txt\")\ndata_k, e_bin, k = arp.k_conv(data, energy, angle, 16.67)\n```\n\nPlease find the detailed documentation here:\n<https://pranabdas.github.io/arpespythontools/>\n\n## Development\n\nClone repository:\n```console\ngit clone https://github.com/pranabdas/arpespythontools\n```\n\nInstall project in editable mode:\n```console\npip install -e .\n```\n\nRun tests locally:\n```console\npython3 -m unittest discover tests\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Explore, analyze, visualize Angle Resolved Photoemission Spectroscopy (ARPES) data.",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://pranabdas.github.io/arpespythontools/docs/",
"Homepage": "https://pranabdas.github.io/arpespythontools/",
"Repository": "https://github.com/pranabdas/arpespythontools"
},
"split_keywords": [
"python",
" data-analysis",
" matplotlib",
" materials-science",
" surface-science",
" condensed-matter-physics",
" photoelectron-spectroscopy",
" arpes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6d7b6738642804aba9cd668097b5548d8863624f0e63b3767b46f0a953bf58a",
"md5": "522adf9c1be852cbbe915de80310dad7",
"sha256": "538f8d4c6bbeac929decf923c494b99b32ff53f75cda6c233023aa04d5e1e00d"
},
"downloads": -1,
"filename": "arpespythontools-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "522adf9c1be852cbbe915de80310dad7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 20028,
"upload_time": "2024-10-07T07:40:13",
"upload_time_iso_8601": "2024-10-07T07:40:13.134900Z",
"url": "https://files.pythonhosted.org/packages/f6/d7/b6738642804aba9cd668097b5548d8863624f0e63b3767b46f0a953bf58a/arpespythontools-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b099d1487af3db96e69651c154671b61301f1ce1e5c777a22a407828b33afea5",
"md5": "294bc9b36d0e0a1b6b99f3ad29636a42",
"sha256": "605461a1a121110a2cbd8b6ac8a0806cca1b342cc90fc7e4cbf3b97ea80caf96"
},
"downloads": -1,
"filename": "arpespythontools-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "294bc9b36d0e0a1b6b99f3ad29636a42",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 12237,
"upload_time": "2024-10-07T07:40:14",
"upload_time_iso_8601": "2024-10-07T07:40:14.187609Z",
"url": "https://files.pythonhosted.org/packages/b0/99/d1487af3db96e69651c154671b61301f1ce1e5c777a22a407828b33afea5/arpespythontools-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 07:40:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pranabdas",
"github_project": "arpespythontools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "arpespythontools"
}
JSON
