# SpaceCherenkovSimulator
A Python-based tool to simulate the effect of interplanetary charged particles and the van Allen belts on count rates and pulse height distributions in simple Cherenkov detectors in space.
If you use this software for scientific research, please reference SpaceCherenkovSimulator as **C. S. W. Davis and F. Lei (2023). SpaceCherenkovSimulator version {version number}. https://github.com/ssc-maire/SpaceCherenkovSimulator , https://pypi.org/project/SpaceCherenkovSimulator/ . Surrey Space Center, University of Surrey.**
**N.B. Currently this tool only runs on Linux-based machines (if you are a Windows user, you must use [Windows Subsystem for Linux](https://ubuntu.com/wsl) or a virtual machine with Linux to install and run this tool)**
**To use this tool, you must first ensure you have MAGNETOCOSMICS and GRAS installed, as this software acts as a tool to run both of these Geant4-based tools**
This software is relatively complete from a programmatic perspective (although currently only containing relatively simple fused silica Cherenkov radiator geometries), but a relatively easy-to-use user interface and documentation has not yet been created. These should be added over time. For now, I have provided several Jupyter notebooks, `testing_simulator.ipynb` and the more complex notebooks in `rough_example_notebooks`, which provide some examples of how this software can be used. Note that the examples in `rough_example_notebooks` are for an older version of the software, and therefore do not directly work with this version - although the general logic for the calculations remains intact.
Feel free to use and modify/contribute to this software if you wish, and feel free to contact me if you have any questions or run into issues.
## Installation
To install SpaceCherenkovSimulator, simply run
```
sudo pip install SpaceCherenkovSimulator
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ssc-maire/SpaceCherenkovSimulator",
"name": "SpaceCherenkovSimulator",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "space physics earth asymptotic trajectory Cherenkov detector Geant4 GRAS geomagnetic rigidity magnetocosmics trapped particles AE8 AP8",
"author": "Chris S. W. Davis",
"author_email": "ChrisSWDavis@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8f/23/d3f2624e4c9fb1238e1793ee44729481fb643684e2619a3cccc40746878a/SpaceCherenkovSimulator-0.2.5.tar.gz",
"platform": null,
"description": "# SpaceCherenkovSimulator\n\nA Python-based tool to simulate the effect of interplanetary charged particles and the van Allen belts on count rates and pulse height distributions in simple Cherenkov detectors in space.\n\nIf you use this software for scientific research, please reference SpaceCherenkovSimulator as **C. S. W. Davis and F. Lei (2023). SpaceCherenkovSimulator version {version number}. https://github.com/ssc-maire/SpaceCherenkovSimulator , https://pypi.org/project/SpaceCherenkovSimulator/ . Surrey Space Center, University of Surrey.**\n\n**N.B. Currently this tool only runs on Linux-based machines (if you are a Windows user, you must use [Windows Subsystem for Linux](https://ubuntu.com/wsl) or a virtual machine with Linux to install and run this tool)**\n\n**To use this tool, you must first ensure you have MAGNETOCOSMICS and GRAS installed, as this software acts as a tool to run both of these Geant4-based tools**\n\nThis software is relatively complete from a programmatic perspective (although currently only containing relatively simple fused silica Cherenkov radiator geometries), but a relatively easy-to-use user interface and documentation has not yet been created. These should be added over time. For now, I have provided several Jupyter notebooks, `testing_simulator.ipynb` and the more complex notebooks in `rough_example_notebooks`, which provide some examples of how this software can be used. Note that the examples in `rough_example_notebooks` are for an older version of the software, and therefore do not directly work with this version - although the general logic for the calculations remains intact.\n\nFeel free to use and modify/contribute to this software if you wish, and feel free to contact me if you have any questions or run into issues. \n\n## Installation\n\nTo install SpaceCherenkovSimulator, simply run\n\n```\nsudo pip install SpaceCherenkovSimulator\n```\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Python library containing tools for simulating Cherenkov detector count rates in space.",
"version": "0.2.5",
"project_urls": {
"Homepage": "https://github.com/ssc-maire/SpaceCherenkovSimulator"
},
"split_keywords": [
"space",
"physics",
"earth",
"asymptotic",
"trajectory",
"cherenkov",
"detector",
"geant4",
"gras",
"geomagnetic",
"rigidity",
"magnetocosmics",
"trapped",
"particles",
"ae8",
"ap8"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9297e594f6ce4e1b88cb616b9b5cbfffdc8bedcc823b53018321a569caa2c9ae",
"md5": "f20d29c465ab5a0edb731529bf6501cb",
"sha256": "98d8fc5e37fcad33f2ad5488187ecbe7b35301f407f8a636f486be4861aff9eb"
},
"downloads": -1,
"filename": "SpaceCherenkovSimulator-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f20d29c465ab5a0edb731529bf6501cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 225170,
"upload_time": "2024-03-05T14:16:00",
"upload_time_iso_8601": "2024-03-05T14:16:00.753036Z",
"url": "https://files.pythonhosted.org/packages/92/97/e594f6ce4e1b88cb616b9b5cbfffdc8bedcc823b53018321a569caa2c9ae/SpaceCherenkovSimulator-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f23d3f2624e4c9fb1238e1793ee44729481fb643684e2619a3cccc40746878a",
"md5": "93fd579e4a97a32e97f4557927d2ea9c",
"sha256": "e0c82d891db3bfe11b5591378858312631172777a5c6306a15ef251ec8fe5975"
},
"downloads": -1,
"filename": "SpaceCherenkovSimulator-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "93fd579e4a97a32e97f4557927d2ea9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 211977,
"upload_time": "2024-03-05T14:16:02",
"upload_time_iso_8601": "2024-03-05T14:16:02.147632Z",
"url": "https://files.pythonhosted.org/packages/8f/23/d3f2624e4c9fb1238e1793ee44729481fb643684e2619a3cccc40746878a/SpaceCherenkovSimulator-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 14:16:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ssc-maire",
"github_project": "SpaceCherenkovSimulator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "spacecherenkovsimulator"
}
JSON
