# EASCherSim
[](https://pypi.org/project/easchersim/)
[](https://anaconda.org/easchersim/easchersim)
[](https://gitlab.com/c4341/easchersim/-/commits/main)
This is the release of *EASCherSim*!
This tool simulates the cherenkov light emission for extensive airshowers with trajectories below and above the limb as a full Monte Carlo simulation.
As a result it provides the photon spatial, time and angular distribution at the detection plane. The tool has the option to take the effect of a magnetic field into account.
Various plots can be automatically produced and the results can be saved into root format.
# Installation
`EASCherSim` is available through [pip](https://pypi.org/project/easchersim/) or [conda](https://anaconda.org/easchersim/easchersim).
`python3 -m pip install easchersim`
`conda install -c easchersim easchersim`
:warning: WARNING: root is **not** a dependency to keep the distribution light
*Note:* We recommand the conda install. This allows to easily install root for creating root output files via
`conda install -c conda-forge root`
# Usage
### Create a configuration file
The command line simulator uses store simulation settings in an ini file (read by configparser). To
generate a configuration file run the following, with your choice of file name.
All option can be specified via argument as well (see help menu for details).
`easchersim make-config my_config_file.ini`
### Run cherenkov simulation
Simulate cherenkov photons at detection plane
`easchersim run my_config_file.ini`
# Documentation
The sphinx documentation is available at [GitLab](https://c4341.gitlab.io/easchersim/)
### Help Documentation
Use the `-h` flag for documentation.
```
$ easchersim --help
usage: easchersim [OPTIONS] COMMAND [ARGS]
OPTIONS:
-h, --help show this help message and exit
COMMANDS:
{run,make-config}
run run easchersim for settings from configuration file
make-config Produce configuration file from default and/or given parameters.
```
Help documentation is also available for the commands (run and make-config).
`$ easchersim make-config -h`
`$ easchersim run -h`
### Uninstall
`python3 -m pip uninstall easchersim`
`conda uninstall easchersim`
# Download & Build
### Clone the Repository (for development)
1. `git clone https://gitlab.com/c4341/easchersim.git`
2. `cd easchersim`
3. `python3 -m pip install -e .`
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/c4341/easchersim",
"name": "easchersim",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Extensive Air Shower, Cherenkov, neutrinos, Simulation",
"author": "Austin Cummings, Johannes Eser",
"author_email": "alc6658@psu.edu, jeser@uchicago.edu",
"download_url": "https://files.pythonhosted.org/packages/55/22/e3eb9ef84bf3e26a3efffeb91cb95610c2cd7e187793312c632198249d97/easchersim-1.2.tar.gz",
"platform": null,
"description": "# EASCherSim\n\n\n[](https://pypi.org/project/easchersim/)\n[](https://anaconda.org/easchersim/easchersim)\n[](https://gitlab.com/c4341/easchersim/-/commits/main)\n\nThis is the release of *EASCherSim*!\n\nThis tool simulates the cherenkov light emission for extensive airshowers with trajectories below and above the limb as a full Monte Carlo simulation.\nAs a result it provides the photon spatial, time and angular distribution at the detection plane. The tool has the option to take the effect of a magnetic field into account.\nVarious plots can be automatically produced and the results can be saved into root format.\n\n# Installation\n\n`EASCherSim` is available through [pip](https://pypi.org/project/easchersim/) or [conda](https://anaconda.org/easchersim/easchersim).\n\n`python3 -m pip install easchersim` \n`conda install -c easchersim easchersim`\n\n:warning: WARNING: root is **not** a dependency to keep the distribution light\n\n*Note:* We recommand the conda install. This allows to easily install root for creating root output files via \n `conda install -c conda-forge root`\n\n\n# Usage\n\n\n\n### Create a configuration file\n\nThe command line simulator uses store simulation settings in an ini file (read by configparser). To\ngenerate a configuration file run the following, with your choice of file name.\nAll option can be specified via argument as well (see help menu for details).\n\n`easchersim make-config my_config_file.ini`\n\n### Run cherenkov simulation\n\nSimulate cherenkov photons at detection plane\n\n`easchersim run my_config_file.ini`\n\n# Documentation\n\nThe sphinx documentation is available at [GitLab](https://c4341.gitlab.io/easchersim/)\n\n\n### Help Documentation\n\nUse the `-h` flag for documentation.\n\n```\n$ easchersim --help\nusage: easchersim [OPTIONS] COMMAND [ARGS]\n\nOPTIONS:\n -h, --help show this help message and exit\n\nCOMMANDS:\n {run,make-config}\n run run easchersim for settings from configuration file\n make-config Produce configuration file from default and/or given parameters.\n```\n\nHelp documentation is also available for the commands (run and make-config).\n\n`$ easchersim make-config -h` \n`$ easchersim run -h`\n### Uninstall\n\n`python3 -m pip uninstall easchersim` \n`conda uninstall easchersim`\n\n# Download & Build\n\n### Clone the Repository (for development)\n\n1. `git clone https://gitlab.com/c4341/easchersim.git`\n2. `cd easchersim`\n3. `python3 -m pip install -e .`\n",
"bugtrack_url": null,
"license": "BSD-3-Clause-Clear",
"summary": "A Simulator for Cherenkov photon production and atmopheric transport for Extensive Air Showers",
"version": "1.2",
"project_urls": {
"Homepage": "https://gitlab.com/c4341/easchersim"
},
"split_keywords": [
"extensive air shower",
" cherenkov",
" neutrinos",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8db85cea82e43fd2e7e24f664aef942856e6aa3ebd43633bd1d5bcb73da813f7",
"md5": "7d19de735a2a8747d241aca3a9d113a4",
"sha256": "e44a1e1a18309b5fe66e023ac4be0559037f3fd4a713c106a6f0a55aebe6d885"
},
"downloads": -1,
"filename": "easchersim-1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d19de735a2a8747d241aca3a9d113a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 254028,
"upload_time": "2024-05-08T17:59:38",
"upload_time_iso_8601": "2024-05-08T17:59:38.027967Z",
"url": "https://files.pythonhosted.org/packages/8d/b8/5cea82e43fd2e7e24f664aef942856e6aa3ebd43633bd1d5bcb73da813f7/easchersim-1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5522e3eb9ef84bf3e26a3efffeb91cb95610c2cd7e187793312c632198249d97",
"md5": "09d8a911449eebb4211cebb4ef77a15b",
"sha256": "56147ba9ad5c1cc002897cc58cb296e21e435ad77afff6f12a45c90338e629a0"
},
"downloads": -1,
"filename": "easchersim-1.2.tar.gz",
"has_sig": false,
"md5_digest": "09d8a911449eebb4211cebb4ef77a15b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 600417,
"upload_time": "2024-05-08T17:59:40",
"upload_time_iso_8601": "2024-05-08T17:59:40.150671Z",
"url": "https://files.pythonhosted.org/packages/55/22/e3eb9ef84bf3e26a3efffeb91cb95610c2cd7e187793312c632198249d97/easchersim-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 17:59:40",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "c4341",
"gitlab_project": "easchersim",
"lcname": "easchersim"
}
JSON