# νSpaceSim
[](https://pypi.org/project/nuspacesim/)
[](https://github.com/NuSpaceSim/nuSpaceSim/actions/workflows/pypi-build-test-publish.yml)
[](https://github.com/NuSpaceSim/nuSpaceSim/actions/workflows/pypi-build-test.yml)
[](https://nuspacesim.readthedocs.io/en/latest/?badge=latest)
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](https://github.com/NuSpaceSim/nupyprop).
# Installation
`nuspacesim` is available through [pip](https://pypi.org/project/nuspacesim/).
`python3 -m pip install nuspacesim`
<!-- or `conda create -n nuspacesim -c conda-forge -c nuspacesim 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](https://nuspacesim.readthedocs.io/en/latest/index.html)
### 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 .`
```
___ ___
/\ \ /\ \
\:\ \ \:\ \
\:\ \ \:\ \
_____\:\ \ ___ \:\ \
/::::::::\__\ /\ \ \:\__\
\:\~~\~~\/__/ \:\ \ /:/ /
\:\ \ \:\ /:/ /
\:\ \ \:\/:/ /
\:\__\ \::/ /
\/__/ \/__/
___ ___ ___ ___ ___
/\__\ /\ \ /\ \ /\__\ /\__\
/:/ _/_ /::\ \ /::\ \ /:/ / /:/ _/_
/:/ /\ \ /:/\:\__\ /:/\:\ \ /:/ / /:/ /\__\
/:/ /::\ \ /:/ /:/ / /:/ /::\ \ /:/ / ___ /:/ /:/ _/_
/:/_/:/\:\__\ /:/_/:/ / /:/_/:/\:\__\ /:/__/ /\__\ /:/_/:/ /\__\
\:\/:/ /:/ / \:\/:/ / \:\/:/ \/__/ \:\ \ /:/ / \:\/:/ /:/ /
\::/ /:/ / \::/__/ \::/__/ \:\ /:/ / \::/_/:/ /
\/_/:/ / \:\ \ \:\ \ \:\/:/ / \:\/:/ /
/:/ / \:\__\ \:\__\ \::/ / \::/ /
\/__/ \/__/ \/__/ \/__/ \/__/
___ ___
/\__\ /\ \
/:/ _/_ ___ |::\ \
/:/ /\ \ /\__\ |:|:\ \
/:/ /::\ \ /:/__/ __|:|\:\ \
/:/_/:/\:\__\ /::\ \ /::::|_\:\__\ .
\:\/:/ /:/ / \/\:\ \__ \:\~~\ \/__/
\::/ /:/ / ~~\:\/\__\ \:\ \ /
\/_/:/ / \::/ / \:\ \ /
/:/ / /:/ / \:\__\ /
\/__/ \/__/ \/__/ /
```
Raw data
{
"_id": null,
"home_page": null,
"name": "nuspacesim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "NASA, neutrinos, Simulation",
"author": "Alex Reustle",
"author_email": "alexander.reustle@nasa.gov",
"download_url": null,
"platform": null,
"description": "\n\n# \u03bdSpaceSim\n\n[](https://pypi.org/project/nuspacesim/)\n[](https://github.com/NuSpaceSim/nuSpaceSim/actions/workflows/pypi-build-test-publish.yml)\n[](https://github.com/NuSpaceSim/nuSpaceSim/actions/workflows/pypi-build-test.yml)\n[](https://nuspacesim.readthedocs.io/en/latest/?badge=latest)\n\n\n\nThis is the official release of the *nuspacesim* simulator tool!\n\nThis package simulates upward-going extensive air showers caused by neutrino\ninteractions with the atmosphere. It calculates the tau neutrino acceptance for the\nOptical Cherenkov technique. The simulation is parameterized by an input TOML\nconfiguration file, with settings for detector characteristics and global parameters.\nThe package also provides a python3 API for programatic access.\n\nTau propagation is interpolated using included data tables from [nupyprop](https://github.com/NuSpaceSim/nupyprop).\n\n# Installation\n\n`nuspacesim` is available through [pip](https://pypi.org/project/nuspacesim/).\n\n`python3 -m pip install nuspacesim`\n\n<!-- or `conda create -n nuspacesim -c conda-forge -c nuspacesim nuspacesim`-->\n\n# Usage\n\n\n\n### Create a TOML configuration script\n\nThe command line simulator uses a TOML file to store configuration parameters. To\ngenerate a default configuration file run the following, with your choice of file name.\n\n`nuspacesim create-config my_config_file.toml`\n\n### Run simulator\n\nSimulate neutrino interactions and save the results to a named fits file.\n\n`nuspacesim run my_config_file.toml -o my_nss_sim.fits`\n\n# Documentation\n\nThe sphinx documentation is available at [ReadTheDocs](https://nuspacesim.readthedocs.io/en/latest/index.html)\n\n\n### Help Documentation\n\nUse the `--help` flag for documentation.\n\n```\n$ nuspacesim --help\nUsage: nuspacesim [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --debug / --no-debug\n --help Show this message and exit.\n\nCommands:\n create-config Generate a configuration file from the given parameters.\n run Main Simulator for nuspacesim.\n```\n\nHelp documentation is also available for the subcommands.\n\n` $ nuspacesim run --help `\n\n### Uninstall\n\n`python3 -m pip uninstall nuspacesim`\n\n# Download & Build\n\n### Clone the Repository (for development)\n\n1. `git clone https://github.com/NuSpaceSim/nuSpaceSim.git`\n2. `cd nuSpaceSim`\n3. `python3 -m pip install -e .`\n\n\n\n```\n ___ ___\n /\\ \\ /\\ \\\n \\:\\ \\ \\:\\ \\\n \\:\\ \\ \\:\\ \\\n _____\\:\\ \\ ___ \\:\\ \\\n /::::::::\\__\\ /\\ \\ \\:\\__\\\n \\:\\~~\\~~\\/__/ \\:\\ \\ /:/ /\n \\:\\ \\ \\:\\ /:/ /\n \\:\\ \\ \\:\\/:/ /\n \\:\\__\\ \\::/ /\n \\/__/ \\/__/\n ___ ___ ___ ___ ___\n /\\__\\ /\\ \\ /\\ \\ /\\__\\ /\\__\\\n /:/ _/_ /::\\ \\ /::\\ \\ /:/ / /:/ _/_\n /:/ /\\ \\ /:/\\:\\__\\ /:/\\:\\ \\ /:/ / /:/ /\\__\\\n /:/ /::\\ \\ /:/ /:/ / /:/ /::\\ \\ /:/ / ___ /:/ /:/ _/_\n /:/_/:/\\:\\__\\ /:/_/:/ / /:/_/:/\\:\\__\\ /:/__/ /\\__\\ /:/_/:/ /\\__\\\n \\:\\/:/ /:/ / \\:\\/:/ / \\:\\/:/ \\/__/ \\:\\ \\ /:/ / \\:\\/:/ /:/ /\n \\::/ /:/ / \\::/__/ \\::/__/ \\:\\ /:/ / \\::/_/:/ /\n \\/_/:/ / \\:\\ \\ \\:\\ \\ \\:\\/:/ / \\:\\/:/ /\n /:/ / \\:\\__\\ \\:\\__\\ \\::/ / \\::/ /\n \\/__/ \\/__/ \\/__/ \\/__/ \\/__/\n ___ ___\n /\\__\\ /\\ \\\n /:/ _/_ ___ |::\\ \\\n /:/ /\\ \\ /\\__\\ |:|:\\ \\\n /:/ /::\\ \\ /:/__/ __|:|\\:\\ \\\n /:/_/:/\\:\\__\\ /::\\ \\ /::::|_\\:\\__\\ .\n \\:\\/:/ /:/ / \\/\\:\\ \\__ \\:\\~~\\ \\/__/\n \\::/ /:/ / ~~\\:\\/\\__\\ \\:\\ \\ /\n \\/_/:/ / \\::/ / \\:\\ \\ /\n /:/ / /:/ / \\:\\__\\ /\n \\/__/ \\/__/ \\/__/ /\n\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause-Clear",
"summary": "A Simulator for Space-based Neutrino Detections",
"version": "1.5.1",
"project_urls": null,
"split_keywords": [
"nasa",
" neutrinos",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2f0300575d8a70dcf697891ef905c210fa90e35015ed606bd822f6df3d57cef",
"md5": "820a8cd455432cbbe89102de9eff4fa3",
"sha256": "afe66a62baaa6c640a63ed5031f1f13eb1a6e271d01043ff1217c5fd7bf0a880"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp310-cp310-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "820a8cd455432cbbe89102de9eff4fa3",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 4713236,
"upload_time": "2024-06-13T15:36:52",
"upload_time_iso_8601": "2024-06-13T15:36:52.012135Z",
"url": "https://files.pythonhosted.org/packages/f2/f0/300575d8a70dcf697891ef905c210fa90e35015ed606bd822f6df3d57cef/nuspacesim-1.5.1-cp310-cp310-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b90f979be79669174baaf546c8302cdac4293448798a071a81aa5b90a05779cd",
"md5": "dc9f8654a328469e0d714646b6d96d43",
"sha256": "4018ce1ba91af35ed882ffb26dec0e2e3bab09db680c41f1b3a71baf18f37cce"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "dc9f8654a328469e0d714646b6d96d43",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 4711211,
"upload_time": "2024-06-13T15:36:55",
"upload_time_iso_8601": "2024-06-13T15:36:55.027715Z",
"url": "https://files.pythonhosted.org/packages/b9/0f/979be79669174baaf546c8302cdac4293448798a071a81aa5b90a05779cd/nuspacesim-1.5.1-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5de4d4e40ffb48f6aba1a71afaf1e1dceebe2600ae6cff36dd144c45cb4311d3",
"md5": "284c8e79349f332450a25660f007f6fe",
"sha256": "62b505ed23b9690ee592a80e89e74b5621187f653443a3269608e7db8aef5a1c"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "284c8e79349f332450a25660f007f6fe",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 4749164,
"upload_time": "2024-06-13T15:36:57",
"upload_time_iso_8601": "2024-06-13T15:36:57.237552Z",
"url": "https://files.pythonhosted.org/packages/5d/e4/d4e40ffb48f6aba1a71afaf1e1dceebe2600ae6cff36dd144c45cb4311d3/nuspacesim-1.5.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eae3f85e943099a4ed7a75ba4bbb39e498bdfa9e0e5ee1fc8598df2468ae5af7",
"md5": "9ed8752671a27a6b54bb5edaa4022df8",
"sha256": "4cb33e913637847281b3feb2934655d50f7b3d63a81a96ebda0490f2dbe5cfb9"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp311-cp311-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "9ed8752671a27a6b54bb5edaa4022df8",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 4714497,
"upload_time": "2024-06-13T15:36:59",
"upload_time_iso_8601": "2024-06-13T15:36:59.370025Z",
"url": "https://files.pythonhosted.org/packages/ea/e3/f85e943099a4ed7a75ba4bbb39e498bdfa9e0e5ee1fc8598df2468ae5af7/nuspacesim-1.5.1-cp311-cp311-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "87d1f638fcc757722e099a51f0fad96e463a00224c1e02176800955d31c7f59a",
"md5": "bbe1c3ecbc872bd486321ba566b69fab",
"sha256": "036582391df5547d911bfedba8153480515b477ab3ca023543470555c0d318fd"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "bbe1c3ecbc872bd486321ba566b69fab",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 4712415,
"upload_time": "2024-06-13T15:37:01",
"upload_time_iso_8601": "2024-06-13T15:37:01.773375Z",
"url": "https://files.pythonhosted.org/packages/87/d1/f638fcc757722e099a51f0fad96e463a00224c1e02176800955d31c7f59a/nuspacesim-1.5.1-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0030b92821830fcf8cf3c995decb2081a73da93483e2962298185140126c4103",
"md5": "c1e8691ab1bb4551934ae8fb9c1372a1",
"sha256": "9bd724d92408839346c799827a3c23b3db9aef569c3fdf84b6cdf00d6541db37"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "c1e8691ab1bb4551934ae8fb9c1372a1",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 4750870,
"upload_time": "2024-06-13T15:37:04",
"upload_time_iso_8601": "2024-06-13T15:37:04.021916Z",
"url": "https://files.pythonhosted.org/packages/00/30/b92821830fcf8cf3c995decb2081a73da93483e2962298185140126c4103/nuspacesim-1.5.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "383e4651f4ed407acbe8382cab3bb23c6427c5b7b824574bb385fcf199842509",
"md5": "2ed10654e70a8a2e90f72a0d2f79538a",
"sha256": "0e71f59b38dd72b1e9ec437318cab8b40e0a60f2a26fbfcb6547e2bc38da279f"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp38-cp38-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "2ed10654e70a8a2e90f72a0d2f79538a",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 4713116,
"upload_time": "2024-06-13T15:37:05",
"upload_time_iso_8601": "2024-06-13T15:37:05.805088Z",
"url": "https://files.pythonhosted.org/packages/38/3e/4651f4ed407acbe8382cab3bb23c6427c5b7b824574bb385fcf199842509/nuspacesim-1.5.1-cp38-cp38-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "444c02bde63e7c488accf29fddcac342cf34a96efaafb7695b5f8c3a28e4d2c6",
"md5": "bb8b51ba73f33798749063c3fc2d379d",
"sha256": "00f3bbd558012b81cdd08c350b86cd55ebc5e012b048ac67b30d5c56910ad625"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp38-cp38-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "bb8b51ba73f33798749063c3fc2d379d",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 4711111,
"upload_time": "2024-06-13T15:37:09",
"upload_time_iso_8601": "2024-06-13T15:37:09.398851Z",
"url": "https://files.pythonhosted.org/packages/44/4c/02bde63e7c488accf29fddcac342cf34a96efaafb7695b5f8c3a28e4d2c6/nuspacesim-1.5.1-cp38-cp38-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfe351c6fea06122accd65dc5637313e563eca7c289466afa83eeb264bcf65fc",
"md5": "29058ce7c353acd8129965c8d610b440",
"sha256": "35072f6398de6a5f07e1ffe4233895b660ae1ebbe0bd616229a3bce73f7c8c0b"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "29058ce7c353acd8129965c8d610b440",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 4748935,
"upload_time": "2024-06-13T15:37:12",
"upload_time_iso_8601": "2024-06-13T15:37:12.409066Z",
"url": "https://files.pythonhosted.org/packages/cf/e3/51c6fea06122accd65dc5637313e563eca7c289466afa83eeb264bcf65fc/nuspacesim-1.5.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f60d63e421ebd9ee3bd61a7d23f3dae6ec2df564f0837af2d94f0a7bbb974fde",
"md5": "b0e6ad219076a40d67735c3bd3dfd32d",
"sha256": "884ad9c234998bf003d5fb410981a68ce669f38bf4976a00cc6c9b0a4dae2ad8"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp39-cp39-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "b0e6ad219076a40d67735c3bd3dfd32d",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 4713346,
"upload_time": "2024-06-13T15:37:14",
"upload_time_iso_8601": "2024-06-13T15:37:14.982631Z",
"url": "https://files.pythonhosted.org/packages/f6/0d/63e421ebd9ee3bd61a7d23f3dae6ec2df564f0837af2d94f0a7bbb974fde/nuspacesim-1.5.1-cp39-cp39-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4489617979c2d04589017d185dedd17d0ef9e2bbae649a165c32a35ed4a289b0",
"md5": "7fa8849a81af22f0f424d4df4c169235",
"sha256": "df2d8f2ec128aebd3e34955370d1a53d7063a39403b162d684c306339c75287b"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp39-cp39-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "7fa8849a81af22f0f424d4df4c169235",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 4711321,
"upload_time": "2024-06-13T15:37:17",
"upload_time_iso_8601": "2024-06-13T15:37:17.633229Z",
"url": "https://files.pythonhosted.org/packages/44/89/617979c2d04589017d185dedd17d0ef9e2bbae649a165c32a35ed4a289b0/nuspacesim-1.5.1-cp39-cp39-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f27cac166955984f039218a7ea909463e6375f3380d407b59064f52e13c08b23",
"md5": "7c159a212cba70bdcd372fd6833b9e9b",
"sha256": "f76c6095efe5977eb7e89869e08076c3f08e7db14f214c8567544b9d37001d69"
},
"downloads": -1,
"filename": "nuspacesim-1.5.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "7c159a212cba70bdcd372fd6833b9e9b",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 4749216,
"upload_time": "2024-06-13T15:37:20",
"upload_time_iso_8601": "2024-06-13T15:37:20.037321Z",
"url": "https://files.pythonhosted.org/packages/f2/7c/ac166955984f039218a7ea909463e6375f3380d407b59064f52e13c08b23/nuspacesim-1.5.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-13 15:36:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nuspacesim"
}
JSON