| Name | specsanalyzer JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Python package for loading and converting SPECS Phoibos analyzer data. |
| upload_time | 2025-01-18 15:30:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.8 |
| license | MIT License Copyright (c) 2022 OpenCOMPES 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 |
specs
phoibos
arpes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://opencompes.github.io/specsanalyzer/)
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/specsanalyzer)
[](https://coveralls.io/github/OpenCOMPES/specsanalyzer?branch=main)
# specsanalyzer
This is the package `specsanalyzer` for conversion and handling of SPECS Phoibos analyzer data.
This package contains two modules:
`specsanalyzer` is a package to import and convert MCP analyzer images from SPECS Phoibos analyzers into energy and emission angle/physical coordinates.
`specsscan` is a Python package for loading Specs Phoibos scans acquired with the labview software developed at FHI/EPFL
Tutorials for usage and the API documentation can be found in the [Documentation](https://opencompes.github.io/specsanalyzer/)
## Installation
### Pip (for users)
- Create a new virtual environment using either venv, pyenv, conda, etc. See below for an example.
```bash
python -m venv .specs-venv
```
- Activate your environment:
```bash
source .specs-venv/bin/activate
```
- Install `specsanalyzer` from PyPI:
```bash
pip install specsanalyzer
```
- This should install all the requirements to run `specsanalyzer` and `specsscan`in your environment.
- If you intend to work with Jupyter notebooks, it is helpful to install a Jupyter kernel for your environment. This can be done, once your environment is activated, by typing:
```bash
python -m ipykernel install --user --name=specs_kernel
```
#### Configuration and calib2d file
The conversion procedures require to set up several configuration parameters in a config file. An example config file is provided as part of the package (see documentation). Configuration files can either be passed to the class constructors, or are read from system-wide or user-defined locations (see documentation).
Most importantly, conversion of analyzer data to energy/angular coordinates requires detector calibration data provided by the manufacturer. The corresponding *.calib2d file (e.g. phoibos150.calib2d) are provided together with the spectrometer software, and need to be set in the config file.
### For Contributors
To contribute to the development of `specsanalyzer`, you can follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/OpenCOMPES/specsanalyzer.git
cd specsanalyzer
```
2. Check out test data (optional, requires access rights):
```bash
git submodule sync --recursive
git submodule update --init --recursive
```
2. Install the repository in editable mode:
```bash
pip install -e .
```
Now you have the development version of `specsanalyzer` installed in your local environment. Feel free to make changes and submit pull requests.
### Poetry (for maintainers)
- Prerequisites:
+ Poetry: https://python-poetry.org/docs/
- Create a virtual environment by typing:
```bash
poetry shell
```
- A new shell will be spawned with the new environment activated.
- Install the dependencies from the `pyproject.toml` by typing:
```bash
poetry install --with dev, docs
```
- If you wish to use the virtual environment created by Poetry to work in a Jupyter notebook, you first need to install the optional notebook dependencies and then create a Jupyter kernel for that.
+ Install the optional dependencies `ipykernel` and `jupyter`:
```bash
poetry install -E notebook
```
+ Make sure to run the command below within your virtual environment (`poetry run` ensures this) by typing:
```bash
poetry run ipython kernel install --user --name=specs_poetry
```
+ The new kernel will now be available in your Jupyter kernels list.
Raw data
{
"_id": null,
"home_page": null,
"name": "specsanalyzer",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": null,
"keywords": "specs, phoibos, arpes",
"author": null,
"author_email": "Laurenz Rettig <rettig@fhi-berlin.mpg.de>, Michele Puppin <michele.puppin@epfl.ch>, Abeer Arora <arora@fhi-berlin.mpg.de>",
"download_url": "https://files.pythonhosted.org/packages/a1/fd/1a56d0da8d46d622a51675060cba3fd5633fb3ff8d354f74271d8bd8838b/specsanalyzer-0.5.1.tar.gz",
"platform": null,
"description": "[](https://opencompes.github.io/specsanalyzer/)\n[](https://github.com/astral-sh/ruff)\n\n\n\n\n[](https://pypi.org/project/specsanalyzer)\n[](https://coveralls.io/github/OpenCOMPES/specsanalyzer?branch=main)\n\n# specsanalyzer\nThis is the package `specsanalyzer` for conversion and handling of SPECS Phoibos analyzer data.\n\nThis package contains two modules:\n`specsanalyzer` is a package to import and convert MCP analyzer images from SPECS Phoibos analyzers into energy and emission angle/physical coordinates.\n`specsscan` is a Python package for loading Specs Phoibos scans acquired with the labview software developed at FHI/EPFL\n\nTutorials for usage and the API documentation can be found in the [Documentation](https://opencompes.github.io/specsanalyzer/)\n\n## Installation\n\n### Pip (for users)\n\n- Create a new virtual environment using either venv, pyenv, conda, etc. See below for an example.\n\n```bash\npython -m venv .specs-venv\n```\n\n- Activate your environment:\n\n```bash\nsource .specs-venv/bin/activate\n```\n\n- Install `specsanalyzer` from PyPI:\n\n```bash\npip install specsanalyzer\n```\n\n- This should install all the requirements to run `specsanalyzer` and `specsscan`in your environment.\n\n- If you intend to work with Jupyter notebooks, it is helpful to install a Jupyter kernel for your environment. This can be done, once your environment is activated, by typing:\n\n```bash\npython -m ipykernel install --user --name=specs_kernel\n```\n\n#### Configuration and calib2d file\nThe conversion procedures require to set up several configuration parameters in a config file. An example config file is provided as part of the package (see documentation). Configuration files can either be passed to the class constructors, or are read from system-wide or user-defined locations (see documentation).\n\nMost importantly, conversion of analyzer data to energy/angular coordinates requires detector calibration data provided by the manufacturer. The corresponding *.calib2d file (e.g. phoibos150.calib2d) are provided together with the spectrometer software, and need to be set in the config file.\n\n### For Contributors\n\nTo contribute to the development of `specsanalyzer`, you can follow these steps:\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/OpenCOMPES/specsanalyzer.git\ncd specsanalyzer\n```\n\n2. Check out test data (optional, requires access rights):\n\n```bash\ngit submodule sync --recursive\ngit submodule update --init --recursive\n```\n\n2. Install the repository in editable mode:\n\n```bash\npip install -e .\n```\n\nNow you have the development version of `specsanalyzer` installed in your local environment. Feel free to make changes and submit pull requests.\n\n### Poetry (for maintainers)\n\n- Prerequisites:\n + Poetry: https://python-poetry.org/docs/\n\n- Create a virtual environment by typing:\n\n```bash\npoetry shell\n```\n\n- A new shell will be spawned with the new environment activated.\n\n- Install the dependencies from the `pyproject.toml` by typing:\n\n```bash\npoetry install --with dev, docs\n```\n\n- If you wish to use the virtual environment created by Poetry to work in a Jupyter notebook, you first need to install the optional notebook dependencies and then create a Jupyter kernel for that.\n\n + Install the optional dependencies `ipykernel` and `jupyter`:\n\n ```bash\n poetry install -E notebook\n ```\n\n + Make sure to run the command below within your virtual environment (`poetry run` ensures this) by typing:\n\n ```bash\n poetry run ipython kernel install --user --name=specs_poetry\n ```\n\n + The new kernel will now be available in your Jupyter kernels list.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 OpenCOMPES 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": "Python package for loading and converting SPECS Phoibos analyzer data.",
"version": "0.5.1",
"project_urls": {
"documentation": "https://opencompes.github.io/docs/specsanalyzer/latest/",
"repository": "https://github.com/OpenCOMPES/specsanalyzer"
},
"split_keywords": [
"specs",
" phoibos",
" arpes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81b5c3f66fd5912ef3806d2247ce4d478300367b3068043376de1771df0e1f32",
"md5": "6357b39fc52afa00da904260c92700b2",
"sha256": "780d5c47e8899fd8facb231d86cea2862fe0028470ee0d67f1e5f714c7d15dd5"
},
"downloads": -1,
"filename": "specsanalyzer-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6357b39fc52afa00da904260c92700b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 43429,
"upload_time": "2025-01-18T15:30:41",
"upload_time_iso_8601": "2025-01-18T15:30:41.323864Z",
"url": "https://files.pythonhosted.org/packages/81/b5/c3f66fd5912ef3806d2247ce4d478300367b3068043376de1771df0e1f32/specsanalyzer-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1fd1a56d0da8d46d622a51675060cba3fd5633fb3ff8d354f74271d8bd8838b",
"md5": "5aa6920c951ba55cddb38091c354c11c",
"sha256": "edc5b8f4e4ba942726f7830e9f76f8bb4d59f783fa8623c07f5c7ed627de0f24"
},
"downloads": -1,
"filename": "specsanalyzer-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "5aa6920c951ba55cddb38091c354c11c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 38281,
"upload_time": "2025-01-18T15:30:44",
"upload_time_iso_8601": "2025-01-18T15:30:44.054351Z",
"url": "https://files.pythonhosted.org/packages/a1/fd/1a56d0da8d46d622a51675060cba3fd5633fb3ff8d354f74271d8bd8838b/specsanalyzer-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-18 15:30:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenCOMPES",
"github_project": "specsanalyzer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "specsanalyzer"
}
