[]([https://opencompes.github.io/sed/](https://opencompes.github.io/docs/sed/latest/))
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/sed-processor)
[](https://coveralls.io/github/OpenCOMPES/sed?branch=main)
**sed-processor** is a backend to process and bin multidimensional single-event datastreams, with the intended primary use case in multidimensional photoelectron spectroscopy using time-of-flight instruments.
It builds on [Dask](https://www.dask.org/) dataframes, where each column represents a multidimensional "coordinate" such as position, time-of-flight, pump-probe delay etc., and each entry represents one electron. The `SedProcessor` class provides a single user entry point, and provides functions for handling various workflows for coordinate transformation, e.g. corrections and calibrations.
Furthermore, "sed-processor" provides fast and parallelized binning routines to compute multidimensional histograms from the processed dataframes in a delayed fashion, thus reducing requirements on cpu power and memory consumption.
Finally, in contains several export routines, including export into the [NeXus](https://www.nexusformat.org/) format with rich and standardized metadata annotation.
# Installation
## Prerequisites
- Python 3.8+
- pip
## Steps
- Create a new virtual environment using either venv, pyenv, conda, etc. See below for an example.
```bash
python -m venv .sed-venv
```
- Activate your environment:
```bash
# On macOS/Linux
source .sed-venv/bin/activate
# On Windows
.sed-venv\Scripts\activate
```
- Install `sed`, distributed as `sed-processor` on PyPI:
```bash
pip install sed-processor[all]
```
- 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=sed_kernel
```
- If you do not use Jupyter Notebook or Jupyter Lab, you can skip the installing those dependencies
```bash
pip install sed-processor
```
# Documentation
Comprehensive documentation including several workflow examples can be found here:
https://opencompes.github.io/docs/sed/latest/
# Contributing
Users are welcome to contribute to the development of **sed-processor**. Information how to contribute, including how to install developer versions can be found in the [documentation](https://opencompes.github.io/docs/sed/latest/misc/contribution.html)
We would like to thank our contributors!
[](https://github.com/OpenCOMPES/sed/graphs/contributors)
## License
sed-processor is licenced under the MIT license
Copyright (c) 2022-2024 OpenCOMPES
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenCOMPES/sed",
"name": "sed-processor",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.11.9,>=3.8",
"maintainer_email": null,
"keywords": "sed, mpes, flash, arpes",
"author": "OpenCOMPES team",
"author_email": "sed-processor@mpes.science",
"download_url": "https://files.pythonhosted.org/packages/02/c5/7845eaab588c5abb84c21a76f55e5537378287100d283a7bd99838868cd0/sed_processor-0.3.2.tar.gz",
"platform": null,
"description": "[]([https://opencompes.github.io/sed/](https://opencompes.github.io/docs/sed/latest/))\n[](https://github.com/astral-sh/ruff)\n\n\n\n\n[](https://pypi.org/project/sed-processor)\n[](https://coveralls.io/github/OpenCOMPES/sed?branch=main)\n\n**sed-processor** is a backend to process and bin multidimensional single-event datastreams, with the intended primary use case in multidimensional photoelectron spectroscopy using time-of-flight instruments.\n\nIt builds on [Dask](https://www.dask.org/) dataframes, where each column represents a multidimensional \"coordinate\" such as position, time-of-flight, pump-probe delay etc., and each entry represents one electron. The `SedProcessor` class provides a single user entry point, and provides functions for handling various workflows for coordinate transformation, e.g. corrections and calibrations.\n\nFurthermore, \"sed-processor\" provides fast and parallelized binning routines to compute multidimensional histograms from the processed dataframes in a delayed fashion, thus reducing requirements on cpu power and memory consumption.\n\nFinally, in contains several export routines, including export into the [NeXus](https://www.nexusformat.org/) format with rich and standardized metadata annotation.\n\n# Installation\n\n## Prerequisites\n- Python 3.8+\n- pip\n\n## Steps\n- Create a new virtual environment using either venv, pyenv, conda, etc. See below for an example.\n\n```bash\npython -m venv .sed-venv\n```\n\n- Activate your environment:\n\n```bash\n# On macOS/Linux\nsource .sed-venv/bin/activate\n\n# On Windows\n.sed-venv\\Scripts\\activate\n```\n\n- Install `sed`, distributed as `sed-processor` on PyPI:\n\n```bash\npip install sed-processor[all]\n```\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=sed_kernel\n```\n\n- If you do not use Jupyter Notebook or Jupyter Lab, you can skip the installing those dependencies\n\n```bash\npip install sed-processor\n```\n\n# Documentation\nComprehensive documentation including several workflow examples can be found here:\nhttps://opencompes.github.io/docs/sed/latest/\n\n\n# Contributing\nUsers are welcome to contribute to the development of **sed-processor**. Information how to contribute, including how to install developer versions can be found in the [documentation](https://opencompes.github.io/docs/sed/latest/misc/contribution.html)\n\nWe would like to thank our contributors!\n\n[](https://github.com/OpenCOMPES/sed/graphs/contributors)\n\n\n## License\n\nsed-processor is licenced under the MIT license\n\nCopyright (c) 2022-2024 OpenCOMPES\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Single Event Data Frame Processor: Backend to handle photoelectron resolved datastreams",
"version": "0.3.2",
"project_urls": {
"Documentation": "https://opencompes.github.io/sed/",
"Homepage": "https://github.com/OpenCOMPES/sed",
"Repository": "https://github.com/OpenCOMPES/sed"
},
"split_keywords": [
"sed",
" mpes",
" flash",
" arpes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cfe56e9d501d7d6630e0d1965f6100daa14a98a15d8c78a33a96887ce013b47",
"md5": "78688ac126100b41b1b6750189cb5eb8",
"sha256": "aae5b3f195d37342bedcfdf0ff29e937d01ad4b222b8a6659ddfe6cdb3a9697d"
},
"downloads": -1,
"filename": "sed_processor-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78688ac126100b41b1b6750189cb5eb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11.9,>=3.8",
"size": 147348,
"upload_time": "2024-11-18T21:29:57",
"upload_time_iso_8601": "2024-11-18T21:29:57.709915Z",
"url": "https://files.pythonhosted.org/packages/5c/fe/56e9d501d7d6630e0d1965f6100daa14a98a15d8c78a33a96887ce013b47/sed_processor-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02c57845eaab588c5abb84c21a76f55e5537378287100d283a7bd99838868cd0",
"md5": "215abbd6b5c48d38da92050d11cb1c7f",
"sha256": "cece7f0e1c5addbf6ea147209ffcfdcf3f2cf2e4995df76ebc7bfe4667fafad1"
},
"downloads": -1,
"filename": "sed_processor-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "215abbd6b5c48d38da92050d11cb1c7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11.9,>=3.8",
"size": 131234,
"upload_time": "2024-11-18T21:29:59",
"upload_time_iso_8601": "2024-11-18T21:29:59.615581Z",
"url": "https://files.pythonhosted.org/packages/02/c5/7845eaab588c5abb84c21a76f55e5537378287100d283a7bd99838868cd0/sed_processor-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 21:29:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenCOMPES",
"github_project": "sed",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sed-processor"
}
JSON
