# Twissed
## Overview
Twissed is a Python package 🐍 that provides a large number of data analysis tools for **beam dynamics** and **laser wakefield acceleration** simulations.
Twissed is multi-OS (Windows, Linux, Mac) and can be easily installed everywhere thanks to its low number of dependencies (numpy, pandas, scipy, h5py). It is especially made to run on HPC clusters.
Twissed can read and write data from several sources
* [FBPIC](https://fbpic.github.io/)
* [Smilei](https://smileipic.github.io/Smilei/)
* [Smilei via happi package](https://smileipic.github.io/Smilei/)
* [TraceWin](https://dacm-logiciels.fr/)
* [Astra]()
## Installation
### Requirement
Python 3.7 or greater
* Mandatory packages: numpy pandas scipy h5py.
* Optional packages: matplotlib seaborn happi(smilei)
### Installation
After downloading the project:
* Mac OS/Linux
```shell
python -m pip install -e .
```
* Windows
```shell
py -m pip install -e .
```
## Tutorial
Examples Twissed use are available at https://github.com/Twissed/Twissed_tutorial
MIT License
Copyright (c) 2024 Twissed
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/Twissed/Twissed",
"name": "twissed",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Twiss parameters,Beam dynamics,LWFA,PIC",
"author": "Damien Minenna",
"author_email": "damien.minenna@cea.fr",
"download_url": "https://files.pythonhosted.org/packages/a6/70/815e87a50c8a3a04f3bd3b87e189af6faf44f59c90a2c0564169017360f3/twissed-2.1.1.tar.gz",
"platform": null,
"description": "# Twissed\n\n## Overview\n\nTwissed is a Python package \ud83d\udc0d that provides a large number of data analysis tools for **beam dynamics** and **laser wakefield acceleration** simulations.\n\nTwissed is multi-OS (Windows, Linux, Mac) and can be easily installed everywhere thanks to its low number of dependencies (numpy, pandas, scipy, h5py). It is especially made to run on HPC clusters. \n\nTwissed can read and write data from several sources\n\n* [FBPIC](https://fbpic.github.io/)\n* [Smilei](https://smileipic.github.io/Smilei/)\n* [Smilei via happi package](https://smileipic.github.io/Smilei/)\n* [TraceWin](https://dacm-logiciels.fr/)\n* [Astra]()\n\n## Installation\n### Requirement\n\nPython 3.7 or greater\n\n* Mandatory packages: numpy pandas scipy h5py. \n* Optional packages: matplotlib seaborn happi(smilei)\n\n### Installation\n\nAfter downloading the project:\n\n* Mac OS/Linux\n```shell\npython -m pip install -e .\n```\n\n* Windows\n```shell\npy -m pip install -e .\n```\n\n## Tutorial\n\nExamples Twissed use are available at https://github.com/Twissed/Twissed_tutorial\nMIT License\n\nCopyright (c) 2024 Twissed\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python toolbox for LWFA simulations",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/Twissed/Twissed"
},
"split_keywords": [
"twiss parameters",
"beam dynamics",
"lwfa",
"pic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2fe0b84b9bcbd88c73b6f45ed9442ec61c1579794c70aabc86557b4fdff82ff",
"md5": "353fc722de0f68315d599e002f296e10",
"sha256": "b3a7a9538a3717eb0c77339c5d1abd5a11dfbf32bbdc58837f8c21bf5416ef44"
},
"downloads": -1,
"filename": "twissed-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "353fc722de0f68315d599e002f296e10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 61785,
"upload_time": "2024-01-25T08:21:43",
"upload_time_iso_8601": "2024-01-25T08:21:43.640717Z",
"url": "https://files.pythonhosted.org/packages/f2/fe/0b84b9bcbd88c73b6f45ed9442ec61c1579794c70aabc86557b4fdff82ff/twissed-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a670815e87a50c8a3a04f3bd3b87e189af6faf44f59c90a2c0564169017360f3",
"md5": "1709fe03706cdc796c0ef3934866c6be",
"sha256": "ea22893c18169d84505baf7059000c0bf3bd6c73d6abf48fde61ca6b0022294a"
},
"downloads": -1,
"filename": "twissed-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1709fe03706cdc796c0ef3934866c6be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 50391,
"upload_time": "2024-01-25T08:21:44",
"upload_time_iso_8601": "2024-01-25T08:21:44.712104Z",
"url": "https://files.pythonhosted.org/packages/a6/70/815e87a50c8a3a04f3bd3b87e189af6faf44f59c90a2c0564169017360f3/twissed-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 08:21:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Twissed",
"github_project": "Twissed",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "twissed"
}
JSON
