A Simulator for Space-based Neutrino Detections
Project description
___ ___
/\ \ /\ \
\:\ \ \:\ \
\:\ \ \:\ \
_____\:\ \ ___ \:\ \
/::::::::\__\ /\ \ \:\__\
\:\~~\~~\/__/ \:\ \ /:/ /
\:\ \ \:\ /:/ /
\:\ \ \:\/:/ /
\:\__\ \::/ /
\/__/ \/__/
___ ___ ___ ___ ___
/\__\ /\ \ /\ \ /\__\ /\__\
/:/ _/_ /::\ \ /::\ \ /:/ / /:/ _/_
/:/ /\ \ /:/\:\__\ /:/\:\ \ /:/ / /:/ /\__\
/:/ /::\ \ /:/ /:/ / /:/ /::\ \ /:/ / ___ /:/ /:/ _/_
/:/_/:/\:\__\ /:/_/:/ / /:/_/:/\:\__\ /:/__/ /\__\ /:/_/:/ /\__\
\:\/:/ /:/ / \:\/:/ / \:\/:/ \/__/ \:\ \ /:/ / \:\/:/ /:/ /
\::/ /:/ / \::/__/ \::/__/ \:\ /:/ / \::/_/:/ /
\/_/:/ / \:\ \ \:\ \ \:\/:/ / \:\/:/ /
/:/ / \:\__\ \:\__\ \::/ / \::/ /
\/__/ \/__/ \/__/ \/__/ \/__/
___ ___
/\__\ /\ \
/:/ _/_ ___ |::\ \
/:/ /\ \ /\__\ |:|:\ \
/:/ /::\ \ /:/__/ __|:|\:\ \
/:/_/:/\:\__\ /::\ \ /::::|_\:\__\
\:\/:/ /:/ / \/\:\ \__ \:\~~\ \/__/ .
\::/ /:/ / ~~\:\/\__\ \:\ \ /
\/_/:/ / \::/ / \:\ \ /
/:/ / /:/ / \:\__\ /
\/__/ \/__/ \/__/ /
νSpaceSim
This is the beta release of the nuspacesim simulator tool!
This package simulates upward-going electromagnetic air showers caused by neutrino interactions with the atmosphere. It calculates the tau neutrino acceptance for the Optical Cherenkov technique. The simulation is parameterized by an input XML configuration file, with settings for detector characteristics and global parameters. The package also provides a python3 API for programatic access.
Tau propagation is interpolated using included data tables from Reno et at. 2019.
This package incorporates compiled sub-packages such as nssgeometry and EAScherGen.
Installation
nuspacesim is available through pip and conda
python3 -m pip install nuspacesim
or
conda create -n nuspacesim -c conda-forge -c nuspacesim nuspacesim
Usage
Create an XML configuration script
nuspacesim create-config my_config_file.xml
conda activate nuspacesim
Run simulator
Simulate neutrino interactions and save the results to a fits file.
nuspacesim run my_config_file.xml 1000 8.0 -o my_nss_sim.fits
Help Documentation
Use the --help
flag for documentation.
$ nuspacesim --help
Usage: nuspacesim [OPTIONS] COMMAND [ARGS]...
Options:
--debug / --no-debug
--help Show this message and exit.
Commands:
create-config Generate a configuration file from the given parameters.
run Main Simulator for nuspacesim.
Also works for the subcommands.
$ nuspacesim run --help
Uninstall
python3 -m pip uninstall nuspacesim
Download & Build
Requirements
Conda is no longer required to build nuSpaceSim, although it may be desirable for downloading compilers. All other build and runtime requirements are downloaded automatically during setup.
- python3
- pip
- C++11 (or higher) compiler
Clone the Repository (for development)
git clone https://github.com/NuSpaceSim/nuSpaceSim.git
cd nuSpaceSim
python3 -m pip install -e .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for nuspacesim-0.5.10.post4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fd8054899f7f54168332a5c57bf29bc46c3aec791138fefad7fb032a3b1fb8b |
|
MD5 | 80aadfcaac9eaf0ece08855a7dfd7cdf |
|
BLAKE2b-256 | 13930fba35c9c5afb6f54a62b3b4cc20eac6714f9d2d1d37d6ce5812b4479982 |
Hashes for nuspacesim-0.5.10.post4-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5919d4e447a2d872143c560b5786a314856cf8203201c565002d7df74574c72b |
|
MD5 | 9c5c98073b38c4cc9823a7d85326b3d2 |
|
BLAKE2b-256 | e5dabdccb70b894b1e3983be5104e05378258a8802b532794b6c6399a4694d8f |
Hashes for nuspacesim-0.5.10.post4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea2ac22d332c02f27254836b515f2067fa21662d75b2470350b58ac8f3facd73 |
|
MD5 | e8b7c30545ff143b7dc4f71ae1f5d4f8 |
|
BLAKE2b-256 | fbf5c278074911cd2a76d493b61a6ab86ccc23c5a99a7695a5f7d75c9678264c |
Hashes for nuspacesim-0.5.10.post4-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e4158ddbaa5807d3b947da47c0a0d4877984cf667aa4b37f1a86d57740c237d |
|
MD5 | 47e1fc56e09f5cc2549a3017ee9a4678 |
|
BLAKE2b-256 | 6868a11e8bb0cef948334d3866baa68d332326b11c7ca46b4b1639eb4943ac25 |
Hashes for nuspacesim-0.5.10.post4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 184b5ac126fc7f5bda3a485790b57a3ec96d453499262c641486838f36c4662f |
|
MD5 | 9eacfe3fc80295ab11e9dd51c71174a5 |
|
BLAKE2b-256 | cb67f0a47dd17a0fee91542aa5ddfcdc3923edbcb73c5bde9db6e18878096081 |
Hashes for nuspacesim-0.5.10.post4-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 702b08cd371d3af7f7403de7ce02cf7802d5e6ce9e2ae1b25acd687ef456f26b |
|
MD5 | 14a3470db1622d0bcf06578895869d8f |
|
BLAKE2b-256 | 4f0374d1880398b70b019eb74e76fff02c88998fe79c1ba07ac3b336654c081a |