| Name | collider-check JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | A small package that provides functions to check the observables in a collider, using a collider built with Xsuite. |
| upload_time | 2024-11-21 11:33:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.10 |
| license | MIT License Copyright (c) [2024] [Colas Droin] 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 |
xsuite
accelerator
collider
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# collider-check Package
<p align="center">
<img src="https://img.shields.io/pypi/v/collider-check" alt="PyPI - Version">
<img src="https://img.shields.io/github/commits-since/ColasDroin/collider_check/latest" alt="GitHub commits since latest release">
<img src="https://img.shields.io/github/actions/workflow/status/ColasDroin/collider_check/tests.yaml?label=Tests" alt="GitHub Actions Workflow Status">
<img src="https://img.shields.io/github/license/ColasDroin/collider_check" alt="GitHub License">
<img src="https://img.shields.io/pypi/pyversions/collider-check" alt="PyPI - Python Version">
<img src="https://img.shields.io/badge/Built%20with%20uv-8A2BE2">
</p>
## Overview
A small package that provides functions to check the observables in a collider, using a collider built with [Xsuite](https://github.com/xsuite) as input (must be a json file). Very useful for debugging purposes before/after tracking, and used as a backend of the [simulation dashboard](https://github.com/ColasDroin/simulation-dashboard).
## Installation
The package is available from PyPI, so you can install it with pip:
```bash
pip install collider-check
```
## Usage
You can import the package in your python script and load a collider with:
```python
import collider_check
check = collider_check.from_json("path/to/collider.json")
```
To get a quick summary of the collider observables, use:
```python
check.output_check_as_str('output.txt')
```
## License
This package is distributed under the MIT License. See [LICENSE](LICENSE) for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "collider-check",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "xsuite, accelerator, collider",
"author": null,
"author_email": "Colas Droin <colas.noe.droin@cern.ch>",
"download_url": "https://files.pythonhosted.org/packages/be/a8/6c1f4b1c3b27241710736488091e741a4ac70c159de5d83d844f6aed564c/collider_check-0.3.2.tar.gz",
"platform": null,
"description": "# collider-check Package\n\n<p align=\"center\">\n <img src=\"https://img.shields.io/pypi/v/collider-check\" alt=\"PyPI - Version\">\n <img src=\"https://img.shields.io/github/commits-since/ColasDroin/collider_check/latest\" alt=\"GitHub commits since latest release\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/ColasDroin/collider_check/tests.yaml?label=Tests\" alt=\"GitHub Actions Workflow Status\">\n <img src=\"https://img.shields.io/github/license/ColasDroin/collider_check\" alt=\"GitHub License\"> \n <img src=\"https://img.shields.io/pypi/pyversions/collider-check\" alt=\"PyPI - Python Version\">\n <img src=\"https://img.shields.io/badge/Built%20with%20uv-8A2BE2\">\n</p>\n\n## Overview\n\nA small package that provides functions to check the observables in a collider, using a collider built with [Xsuite](https://github.com/xsuite) as input (must be a json file). Very useful for debugging purposes before/after tracking, and used as a backend of the [simulation dashboard](https://github.com/ColasDroin/simulation-dashboard).\n\n## Installation\n\nThe package is available from PyPI, so you can install it with pip:\n\n```bash\npip install collider-check\n```\n\n## Usage\n\nYou can import the package in your python script and load a collider with:\n\n```python\nimport collider_check\ncheck = collider_check.from_json(\"path/to/collider.json\")\n```\n\nTo get a quick summary of the collider observables, use:\n\n```python\ncheck.output_check_as_str('output.txt')\n```\n\n## License\n\nThis package is distributed under the MIT License. See [LICENSE](LICENSE) for more information.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2024] [Colas Droin] 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": "A small package that provides functions to check the observables in a collider, using a collider built with Xsuite.",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/ColasDroin/collider_check"
},
"split_keywords": [
"xsuite",
" accelerator",
" collider"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e2224e4f9c4137e03651f6e05296a94e57a1418f85d20599e47635c006fd6a92",
"md5": "4b3520372ebf30a2d3974e405bf5d0dc",
"sha256": "41eb0f739f48c6204635cdf0a161caa5bdd9e0efdecf6beba3f41fcf624f60ed"
},
"downloads": -1,
"filename": "collider_check-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b3520372ebf30a2d3974e405bf5d0dc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 12062,
"upload_time": "2024-11-21T11:33:28",
"upload_time_iso_8601": "2024-11-21T11:33:28.480416Z",
"url": "https://files.pythonhosted.org/packages/e2/22/4e4f9c4137e03651f6e05296a94e57a1418f85d20599e47635c006fd6a92/collider_check-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bea86c1f4b1c3b27241710736488091e741a4ac70c159de5d83d844f6aed564c",
"md5": "cb6cae44bc9a07b7a5b0cde0f61d5585",
"sha256": "568dcfcfc83f26b5adc8602200373abac827919342ff06ab128bb9fda832ee1f"
},
"downloads": -1,
"filename": "collider_check-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "cb6cae44bc9a07b7a5b0cde0f61d5585",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 14288,
"upload_time": "2024-11-21T11:33:29",
"upload_time_iso_8601": "2024-11-21T11:33:29.585089Z",
"url": "https://files.pythonhosted.org/packages/be/a8/6c1f4b1c3b27241710736488091e741a4ac70c159de5d83d844f6aed564c/collider_check-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 11:33:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ColasDroin",
"github_project": "collider_check",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "collider-check"
}
