[](https://opencompes.github.io/sed/)
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/sed-processor)
[](https://coveralls.io/github/OpenCOMPES/sed?branch=main)
Backend to handle photoelectron resolved datastreams.
# Installation
## Pip (for users)
- 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
source .sed-venv/bin/activate
```
- Install `sed`, distributed as `sed-processor` on PyPI:
```bash
pip install sed-processor
```
- This should install all the requirements to run `sed` 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=sed_kernel
```
## For Contributors
To contribute to the development of `sed`, you can follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/OpenCOMPES/sed.git
cd sed
```
2. Install the repository in editable mode:
```bash
pip install -e .
```
Now you have the development version of `sed` 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=sed_poetry
```
+ The new kernel will now be available in your Jupyter kernels list.
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenCOMPES/sed",
"name": "sed-processor",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=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/c3/67/19365dfc56d1048ecfd9fb7a3eb8b13522d793009fabb7be195dcb26eb2b/sed_processor-0.1.9.tar.gz",
"platform": null,
"description": "[](https://opencompes.github.io/sed/)\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\nBackend to handle photoelectron resolved datastreams.\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 .sed-venv\n```\n\n- Activate your environment:\n\n```bash\nsource .sed-venv/bin/activate\n```\n\n- Install `sed`, distributed as `sed-processor` on PyPI:\n\n```bash\npip install sed-processor\n```\n\n- This should install all the requirements to run `sed` 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=sed_kernel\n```\n## For Contributors\n\nTo contribute to the development of `sed`, you can follow these steps:\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/OpenCOMPES/sed.git\ncd sed\n```\n\n2. Install the repository in editable mode:\n\n```bash\npip install -e .\n```\n\nNow you have the development version of `sed` 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=sed_poetry\n ```\n\n + The new kernel will now be available in your Jupyter kernels list.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Single Event Data Frame Processor: Backend to handle photoelectron resolved datastreams",
"version": "0.1.9",
"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": "69a3468d328f80749c2c45b24da8720705b3a47bea5a0cebaedb61f67eef31b4",
"md5": "1c67a8eb9b85b9df5292256ce2bc23f0",
"sha256": "272c6fb889f0a41b77905efcb1fe7a834d2a82120aa030bb3659434efbe8156f"
},
"downloads": -1,
"filename": "sed_processor-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c67a8eb9b85b9df5292256ce2bc23f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 136690,
"upload_time": "2024-04-04T09:50:34",
"upload_time_iso_8601": "2024-04-04T09:50:34.717597Z",
"url": "https://files.pythonhosted.org/packages/69/a3/468d328f80749c2c45b24da8720705b3a47bea5a0cebaedb61f67eef31b4/sed_processor-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c36719365dfc56d1048ecfd9fb7a3eb8b13522d793009fabb7be195dcb26eb2b",
"md5": "1ac8637c7de1c2da28223dca2219b389",
"sha256": "aaf999c68825256790e0d87c5b89f817967b7429cb36643b1ab6c6c3ad2ad4b1"
},
"downloads": -1,
"filename": "sed_processor-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "1ac8637c7de1c2da28223dca2219b389",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 121572,
"upload_time": "2024-04-04T09:50:36",
"upload_time_iso_8601": "2024-04-04T09:50:36.393431Z",
"url": "https://files.pythonhosted.org/packages/c3/67/19365dfc56d1048ecfd9fb7a3eb8b13522d793009fabb7be195dcb26eb2b/sed_processor-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 09:50:36",
"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
