Skip to main content

A Simulator for Space-based Neutrino Detections

Project description

NuSpaceSim logo

νSpaceSim

PyPI Build CICD Documentation PyPI - Downloads

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

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)

  1. git clone https://github.com/NuSpaceSim/nuSpaceSim.git
  2. cd nuSpaceSim
  3. python3 -m pip install -e .
      ___           ___
     /\  \         /\  \
     \:\  \        \:\  \
      \:\  \        \:\  \
  _____\:\  \   ___  \:\  \
 /::::::::\__\ /\  \  \:\__\
 \:\~~\~~\/__/ \:\  \ /:/  /
  \:\  \        \:\  /:/  /
   \:\  \        \:\/:/  /
    \:\__\        \::/  /
     \/__/         \/__/
      ___           ___         ___           ___           ___
     /\__\         /\  \       /\  \         /\__\         /\__\
    /:/ _/_       /::\  \     /::\  \       /:/  /        /:/ _/_
   /:/ /\  \     /:/\:\__\   /:/\:\  \     /:/  /        /:/ /\__\
  /:/ /::\  \   /:/ /:/  /  /:/ /::\  \   /:/  /  ___   /:/ /:/ _/_
 /:/_/:/\:\__\ /:/_/:/  /  /:/_/:/\:\__\ /:/__/  /\__\ /:/_/:/ /\__\
 \:\/:/ /:/  / \:\/:/  /   \:\/:/  \/__/ \:\  \ /:/  / \:\/:/ /:/  /
  \::/ /:/  /   \::/__/     \::/__/       \:\  /:/  /   \::/_/:/  /
   \/_/:/  /     \:\  \      \:\  \        \:\/:/  /     \:\/:/  /
     /:/  /       \:\__\      \:\__\        \::/  /       \::/  /
     \/__/         \/__/       \/__/         \/__/         \/__/
      ___                       ___
     /\__\                     /\  \
    /:/ _/_       ___         |::\  \
   /:/ /\  \     /\__\        |:|:\  \
  /:/ /::\  \   /:/__/      __|:|\:\  \
 /:/_/:/\:\__\ /::\  \     /::::|_\:\__\                                  .
 \:\/:/ /:/  / \/\:\  \__  \:\~~\  \/__/
  \::/ /:/  /   ~~\:\/\__\  \:\  \                                      /
   \/_/:/  /       \::/  /   \:\  \                                    /
     /:/  /        /:/  /     \:\__\                                  /
     \/__/         \/__/       \/__/                                 /

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

nuspacesim-2.0.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

nuspacesim-2.0.1-cp313-cp313-macosx_11_0_arm64.whl (4.9 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

nuspacesim-2.0.1-cp313-cp313-macosx_10_13_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

nuspacesim-2.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

nuspacesim-2.0.1-cp312-cp312-macosx_11_0_arm64.whl (4.9 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

nuspacesim-2.0.1-cp312-cp312-macosx_10_13_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

nuspacesim-2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

nuspacesim-2.0.1-cp311-cp311-macosx_11_0_arm64.whl (4.9 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

nuspacesim-2.0.1-cp311-cp311-macosx_10_9_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.11macOS 10.9+ x86-64

nuspacesim-2.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64

nuspacesim-2.0.1-cp310-cp310-macosx_11_0_arm64.whl (4.9 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

nuspacesim-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.10macOS 10.9+ x86-64

nuspacesim-2.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.17+ x86-64

nuspacesim-2.0.1-cp39-cp39-macosx_11_0_arm64.whl (4.9 MB view details)

Uploaded CPython 3.9macOS 11.0+ ARM64

nuspacesim-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.9macOS 10.9+ x86-64

File details

Details for the file nuspacesim-2.0.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a145033b154e05e793cb7c9a01e9355c978b5b9bd612f5b25db72f202efc9723
MD5 56a0bf912ec11479bdc44398a2012776
BLAKE2b-256 066cc26da48661923ce875892fa2a854d03a94706c7a87dbceb20a804cb76991

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 bf631d71ffc19694991d83fd5eb624a0ff872d639a95d77d36e862fc46063ebc
MD5 f6a4eb718f5652c9fb0f796d6358f124
BLAKE2b-256 2c18acf92e7710febf3558be4a281f12bec42e064e3334e965a023dff024933c

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp313-cp313-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 5b906392ab667c3837b15f997768813e0c97f0cd2d55ce62eae58ba8ff257f9a
MD5 91532132e83410ce4c7b8be6880a422e
BLAKE2b-256 a8016ebaabccee210140e726a403d16d9a4371bd334914107c0abd8beec248d2

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0ce0344a3a9911b925e0318dd9362473a3e25b00c9cab876d4391e47fa029d9a
MD5 f90f94a49ffcac2ee6cc3fd50c8fb458
BLAKE2b-256 893b16503620bddeb7221cdb0147029d5a5a1f2253f4659b06943671d94a2d42

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2f193d57e15c24c2e4b8e3943e79af3d9817e3bd88c6be6a378cc6c6885f8b62
MD5 f8ac71fd0745282dd890e5b652f5feb9
BLAKE2b-256 b64c1ee31393cb8ab6d9418e51fce01a4b104c6a9c6923fcac80be9b5c109e82

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 b71e90e84ea927892b07b2c91734195116be42f4732a657ffb20cc35adc39c96
MD5 ccc5003cda848c50afe7d036e3287e0d
BLAKE2b-256 e85eee8e644bee3f6c645ae93d2883c897de8382461e82ebfe20babc330c9d3d

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5bd1246380f27327e6d17471f6e4f509361c51096e0187071e88e7b0baeff843
MD5 a71dcbbdcfd9ebaa03dfec5e37e5293b
BLAKE2b-256 7fcdbc75860bfe7f3f88de553663fd8b9962b841681478f7ade9b49ad4a5d847

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1e66ea177d45396e178413535335f9179a90b32dcfb08e56ef072b05442a3291
MD5 1d2e8f8ba60f7c3407dda25c427c06f8
BLAKE2b-256 e65cf59d072d5acfed42d198bc565b87a5f1cce3dd9038c2960f98c7266bc73f

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 43a8efa69350c09f2e49ad162b2b6a72364a38839ef62790a63c30a7abe88677
MD5 905c53274e72ecff528aa88720c9db23
BLAKE2b-256 7645f4650fd491a9d04563c60e1c7d201241b1548312f849a516f649e8b1ee4a

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 08408d928c1cb57c42fc60148f4fae00b449455f9271961e34d785c2b6c0c1a8
MD5 3bcd4560fdf2ff1199922c582d5ea715
BLAKE2b-256 3cb37258d630ece3a511f4ed783ed9de7c9e93d92d9430b5318c9c6ee1c15ddf

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 42d6b4e3c9f001c45908acd2f8b47a8024d88d691a4aa372c50abac24d51055b
MD5 d2cf6e1b06c661a072798484b0394cc5
BLAKE2b-256 e4b65426f0464ddfa9b6ef42adfb1abed8619c9f0c964cd981170b089e83ec43

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 93e31630a7583f01a3dd491e7d1eb2866918ff492d866405695abf5e9be33b27
MD5 74e64b6cc3ca1e9136db50ae07facbfa
BLAKE2b-256 792c0500a9065bb9e5b80e6e963e7660f27956cf825adc28b9dd28e4d5f3ecfc

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 47e826bf263e6c6b735a279b1212d3d9c498c48439ae6fe5b49a6121fa27311b
MD5 11f93774f4aa08646826b7ec6487a913
BLAKE2b-256 d945ade12dbaa9e97404b7f7190e55ae4b1f6f292baa2d1c6e16cbc48d4ddcfc

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9c4c97ee6753b7facdc77acdc4fa57c77b5c7ef2a924c03f3a06d7e4b6fd3b32
MD5 8fa552ececaf16fa4ccea4f3226cddb4
BLAKE2b-256 099a031324a4d80a1ef7ca73e92c7466c255db69c24604aa61a248eb3f39cb59

See more details on using hashes here.

File details

Details for the file nuspacesim-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for nuspacesim-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6eccdd15a887478e28aa38e2f58471f623099cb87fe85ca37f719baeec8aa0d6
MD5 f7e007a931ef6a663b5b38fdb2de6f1f
BLAKE2b-256 bebbe781eb72a820db4eb801950d5fbf3148b7ab0b165089af9adf5deb12e571

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page