Metadata-Version: 2.1
Name: SpaceCherenkovSimulator
Version: 0.1.2
Summary: Python library containing tools for simulating Cherenkov detector count rates in space.
Home-page: https://github.com/ssc-maire/SpaceCherenkovSimulator
Author: Chris S. W. Davis
Author-email: ChrisSWDavis@gmail.com
License: GNU General Public License v3.0
Keywords: space physics earth asymptotic trajectory Cherenkov detector Geant4 GRAS geomagnetic rigidity magnetocosmics trapped particles AE8 AP8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: AsympDirsCalculator>=1.0.7
Requires-Dist: CosRayModifiedISO>=1.2
Requires-Dist: geopandas>=0.11.1
Requires-Dist: joblib>=1.2.0
Requires-Dist: matplotlib>=3.5.2
Requires-Dist: numpy>=1.23.1
Requires-Dist: pandas>=1.4.3
Requires-Dist: ParticleRigidityCalculationTools>=1.5.3
Requires-Dist: pyarrow>=12.0.0
Requires-Dist: scipy>=1.10.1
Requires-Dist: seaborn>=0.13.0
Requires-Dist: setuptools>=45.2.0
Requires-Dist: sketch>=0.4.2
Requires-Dist: spacepy>=0.4.1
Requires-Dist: tqdm>=4.30.0
Requires-Dist: uncertainties>=3.1.7
Requires-Dist: uproot>=5.1.2

# 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.

**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
```

