νSpaceSim
This is the official release of the nuspacesim simulator tool!
This package simulates upward-going extensive 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 TOML 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 nupyprop.
Installation
nuspacesim is available through pip.
python3 -m pip install nuspacesim
Usage
Create a TOML configuration script
The command line simulator uses a TOML file to store configuration parameters. To generate a default configuration file run the following, with your choice of file name.
nuspacesim create-config my_config_file.toml
Run simulator
Simulate neutrino interactions and save the results to a named fits file.
nuspacesim run my_config_file.toml -o my_nss_sim.fits
Documentation
The sphinx documentation is available at ReadTheDocs
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.
Help documentation is also available for the subcommands.
$ nuspacesim run --help
Uninstall
python3 -m pip uninstall nuspacesim
Download & Build
Clone the Repository (for development)
git clone https://github.com/NuSpaceSim/nuSpaceSim.gitcd nuSpaceSimpython3 -m pip install -e .
___ ___
/\ \ /\ \
\:\ \ \:\ \
\:\ \ \:\ \
_____\:\ \ ___ \:\ \
/::::::::\__\ /\ \ \:\__\
\:\~~\~~\/__/ \:\ \ /:/ /
\:\ \ \:\ /:/ /
\:\ \ \:\/:/ /
\:\__\ \::/ /
\/__/ \/__/
___ ___ ___ ___ ___
/\__\ /\ \ /\ \ /\__\ /\__\
/:/ _/_ /::\ \ /::\ \ /:/ / /:/ _/_
/:/ /\ \ /:/\:\__\ /:/\:\ \ /:/ / /:/ /\__\
/:/ /::\ \ /:/ /:/ / /:/ /::\ \ /:/ / ___ /:/ /:/ _/_
/:/_/:/\:\__\ /:/_/:/ / /:/_/:/\:\__\ /:/__/ /\__\ /:/_/:/ /\__\
\:\/:/ /:/ / \:\/:/ / \:\/:/ \/__/ \:\ \ /:/ / \:\/:/ /:/ /
\::/ /:/ / \::/__/ \::/__/ \:\ /:/ / \::/_/:/ /
\/_/:/ / \:\ \ \:\ \ \:\/:/ / \:\/:/ /
/:/ / \:\__\ \:\__\ \::/ / \::/ /
\/__/ \/__/ \/__/ \/__/ \/__/
___ ___
/\__\ /\ \
/:/ _/_ ___ |::\ \
/:/ /\ \ /\__\ |:|:\ \
/:/ /::\ \ /:/__/ __|:|\:\ \
/:/_/:/\:\__\ /::\ \ /::::|_\:\__\ .
\:\/:/ /:/ / \/\:\ \__ \:\~~\ \/__/
\::/ /:/ / ~~\:\/\__\ \:\ \ /
\/_/:/ / \::/ / \:\ \ /
/:/ / /:/ / \:\__\ /
\/__/ \/__/ \/__/ /
1 maintainer
Metadata
1 maintainer
Release files for nuspacesim 2.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 78.3 MB
Release files / nuspacesim-2.1.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
5e1b5473bf59bdb83473c058c48a71af9ef15acf76256916a0c1e086610f6057
|
|
BLAKE2b-256 checksum How to use checksums |
82bbb489ff18620d9d6e76fad37720ce127d5754e9841d96d5caab3825ebadaa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | nuspacesim-2.1.1-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
288d482a39c5ef45733758ccc9d8fa8fbe8c473095038ae71f53fd603f540218
|
|
BLAKE2b-256 checksum How to use checksums |
2a42249220d42f989bb63f4042b5ba7477c25abe27013560f72dd8b0fc570f34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp313-cp313-macosx_10_13_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp313-cp313-macosx_10_13_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.13 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
6eb1d0c3d9fd90e1b5d60e087b4c1cab9ae898c45597048b5d36e7ec672fd5e6
|
|
BLAKE2b-256 checksum How to use checksums |
808c3075490da6071ca5fefd8feea3dcf3e00063cc2139eb405ddc3d99a575ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
83fee9bc6dcd045341ae6fac72074c8f990b2dc9bd611d1309a20beabe177d30
|
|
BLAKE2b-256 checksum How to use checksums |
d66ed9a9ef3c4fa8ab7368ff914ee570e011c55914b7a33722dba48404865fc3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | nuspacesim-2.1.1-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
0fe09a09a5e8ad897d16c3d8a6e4067e87a03f46f3a8a226289da6becdcbec65
|
|
BLAKE2b-256 checksum How to use checksums |
3a380a89b1d955f3ee5936f05d779716e1627010a2050d05ab59620a926e8850
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp312-cp312-macosx_10_13_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp312-cp312-macosx_10_13_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.12 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
013b79154b5f12ad1e373913b2b2284dffa315bae2377bbb173c324546aadd9d
|
|
BLAKE2b-256 checksum How to use checksums |
a54713cb712e2d2e85489bf536ef653802dc7831e59ecda8b6144621ed663be6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
68eb8c2d2ab600e9157f3345c701c08ffb9378ddad56bbf1943aa6946b0480b6
|
|
BLAKE2b-256 checksum How to use checksums |
2013799885b966b449741149dabdd18ccfc8fdb0b2f7b5f3a8d1914d9cd89788
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | nuspacesim-2.1.1-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
6fc84cfca65ef97381152a28f21ff5ff05397d480d35887c43e8f4cd270c6f7d
|
|
BLAKE2b-256 checksum How to use checksums |
932c66c0a8af79aa0ab92fb607167f8b107823fc01631c878e0968d17a281d02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp311-cp311-macosx_10_9_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp311-cp311-macosx_10_9_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.11 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
a1d62bae11f05eaeb65fa02406a7d80504aec83b1c5248b1fb9923fc15f7c2b9
|
|
BLAKE2b-256 checksum How to use checksums |
8d0e0d9374099ccc499f2b86b079aa1d8e77851002f088c15ed9c13f39677842
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
0d3f6043eb4b8e6ad23e9ac18aff3d2bf0e4343a068f73635c16f02ea0d95e54
|
|
BLAKE2b-256 checksum How to use checksums |
2dbc61359b6ebab4cb71126355a77d46c0e59a390e5fbe559bbb4e98a744a776
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | nuspacesim-2.1.1-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
df6826a638ec0255d849d148b96bc4d714f4cab553586c0af8c2ae4ea356c0d3
|
|
BLAKE2b-256 checksum How to use checksums |
9344a89a87150f168f245df4ba4c23ca463ab874191258c0f13742cc5d31c770
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp310-cp310-macosx_10_9_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp310-cp310-macosx_10_9_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.10 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
60f71235e61f932014a3dd65babacf03d38a6f2a1e7ddb8aa84383a6da486400
|
|
BLAKE2b-256 checksum How to use checksums |
ebd4fa37487b060e1b217a96656f09de422272d81b9e0cef4660708c23ca80b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
eca5ca292eaee087272cf01bf0c281976160dc557bd4ae1d21a406f37c905f79
|
|
BLAKE2b-256 checksum How to use checksums |
4e08f02e90abdd0f87fdc4b91f24e9db356e9ebf05776cafdd360fbe956426a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp39-cp39-macosx_11_0_arm64.whl
| Download URL | nuspacesim-2.1.1-cp39-cp39-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.9 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
3854ade52bff06f6cb9f08a656fc71dcbe7dd9545b9eb5a7921c086f3988e7ba
|
|
BLAKE2b-256 checksum How to use checksums |
c7e1cd0a4f2587197896370987c232786d5865d4a046eaeaac6c8d2f456fa1dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / nuspacesim-2.1.1-cp39-cp39-macosx_10_9_x86_64.whl
| Download URL | nuspacesim-2.1.1-cp39-cp39-macosx_10_9_x86_64.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.9 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
ddc7a908d07114f254ea277ae4b1b7b1a920de4c0517b247a5067269ac448fe2
|
|
BLAKE2b-256 checksum How to use checksums |
7d033023bd29b5cb7caff4657712e269efd4f01c007304ae3bf2e14055212b22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
