| Name | oxfel JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | https://github.com/st-walker/esmesim |
| Summary | The official UNOFFICIAL model of the EuXFEL in OCELOT |
| upload_time | 2024-05-15 10:09:04 |
| maintainer | None |
| docs_url | None |
| author | Stuart Walker |
| requires_python | <4.0,>=3.10.11 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=====
oxfel
=====
.. image:: https://img.shields.io/pypi/v/oxfel.svg
:target: https://pypi.python.org/pypi/oxfel
.. image:: https://github.com/st-walker/ocelot-euxfel/actions/workflows/ci.yaml/badge.svg
:target: https://github.com/st-walker/ocelot-euxfel/actions/workflows/ci.yaml
.. image:: https://readthedocs.org/projects/oxfel/badge/?version=latest
:target: https://oxfel.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
ocelot xfel model
Adapted from https://www.desy.de/xfel-beam/s2e/xfel/Nominal/nom250pC.html which remains the official public EuXFEL ocelot model. This reposity is here for me to make my life easier and to make running start to end simulations less tedious, error-prone and complicated. It is not an official, DESY-endorsed model of the EuXFEL.
* Free software: MIT license
* Documentation: https://oxfel.readthedocs.io.
History
-------
* 0.1.0: Started with model of ocelot I got from Sergey for simulating the injector.
Overview
--------
TODO
----
* Automatic CSR bunch length parametrisation
* Deal with doubled up marker choice (e.g. DUMP.CSR.START).
* Be consistent with open/closed intervals.
* Don't allow start/stops to have any thickness only allow with markers. Unless start is a float...
* Check SBEND length correction is done correctly (use chords or arcs)
* Check physics processes.
Features
--------
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
Raw data
{
"_id": null,
"home_page": "https://github.com/st-walker/esmesim",
"name": "oxfel",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10.11",
"maintainer_email": null,
"keywords": null,
"author": "Stuart Walker",
"author_email": "stuart.walker@desy.de",
"download_url": "https://files.pythonhosted.org/packages/9e/d0/be55d79dbaa6d5c1b3b580627ecf3c68a8a098901242dab7cd4d1dc42a7f/oxfel-0.5.0.tar.gz",
"platform": null,
"description": "=====\noxfel\n=====\n\n.. image:: https://img.shields.io/pypi/v/oxfel.svg\n :target: https://pypi.python.org/pypi/oxfel\n\n.. image:: https://github.com/st-walker/ocelot-euxfel/actions/workflows/ci.yaml/badge.svg\n :target: https://github.com/st-walker/ocelot-euxfel/actions/workflows/ci.yaml\n\n.. image:: https://readthedocs.org/projects/oxfel/badge/?version=latest\n :target: https://oxfel.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\n\n\n\nocelot xfel model\n\nAdapted from https://www.desy.de/xfel-beam/s2e/xfel/Nominal/nom250pC.html which remains the official public EuXFEL ocelot model. This reposity is here for me to make my life easier and to make running start to end simulations less tedious, error-prone and complicated. It is not an official, DESY-endorsed model of the EuXFEL.\n\n\n* Free software: MIT license\n* Documentation: https://oxfel.readthedocs.io.\n\n\nHistory\n-------\n\n* 0.1.0: Started with model of ocelot I got from Sergey for simulating the injector.\n\nOverview\n--------\n\n\nTODO\n----\n\n* Automatic CSR bunch length parametrisation\n* Deal with doubled up marker choice (e.g. DUMP.CSR.START).\n* Be consistent with open/closed intervals.\n* Don't allow start/stops to have any thickness only allow with markers. Unless start is a float...\n* Check SBEND length correction is done correctly (use chords or arcs)\n* Check physics processes.\n\n\nFeatures\n--------\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The official UNOFFICIAL model of the EuXFEL in OCELOT",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/st-walker/esmesim"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bff2035421621ce71869f39e8ef7b7dfd91e7f4480d45ef23c356bd1077acf53",
"md5": "a92df44230d0be0c26f4507075debb07",
"sha256": "b7544d5dcf7d07c62d4d0cedc84db2a260741c5ff8651297328db45624ae23f5"
},
"downloads": -1,
"filename": "oxfel-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a92df44230d0be0c26f4507075debb07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10.11",
"size": 16150115,
"upload_time": "2024-05-15T10:09:01",
"upload_time_iso_8601": "2024-05-15T10:09:01.149024Z",
"url": "https://files.pythonhosted.org/packages/bf/f2/035421621ce71869f39e8ef7b7dfd91e7f4480d45ef23c356bd1077acf53/oxfel-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ed0be55d79dbaa6d5c1b3b580627ecf3c68a8a098901242dab7cd4d1dc42a7f",
"md5": "0739078ed5898275bd29239f854e236a",
"sha256": "16b0a162e0dc09dedc475666e8cea40f50367f2f46323cf9c2eebbf19b6fe4f2"
},
"downloads": -1,
"filename": "oxfel-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "0739078ed5898275bd29239f854e236a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10.11",
"size": 16115279,
"upload_time": "2024-05-15T10:09:04",
"upload_time_iso_8601": "2024-05-15T10:09:04.671468Z",
"url": "https://files.pythonhosted.org/packages/9e/d0/be55d79dbaa6d5c1b3b580627ecf3c68a8a098901242dab7cd4d1dc42a7f/oxfel-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 10:09:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "st-walker",
"github_project": "esmesim",
"github_not_found": true,
"lcname": "oxfel"
}
