Skip to main content

Modelling cosmic-ray showers, their light production and its detection

Project description

ShowerModel logo

A Python package for modelling cosmic-ray showers, their light production and their detection.



Install

  • Install miniconda or anaconda first.

As user

SHOWERMODEL_VER=0.1.3
wget https://raw.githubusercontent.com/JaimeRosado/ShowerModel/v$SHOWERMODEL_VER/environment.yml
conda env create -n showermodel -f environment.yml
conda activate showermodel
pip install ShowerModel
rm environment.yml

Note: If pip install ShowerModel fails as it is, you probably need to use --user option. This may happen in Windows installations.

pip install --user ShowerModel

As developer

  • Create and activate the conda environment:
git clone https://github.com/JaimeRosado/ShowerModel.git
cd ShowerModel
conda env create -f environment.yml
conda activate showermodel
  • To update the environment (e.g. when dependencies get updated), use:
conda env update -n showermodel -f environment.yml

To install ShowerModel, run the following command from the ShowerModel root directory:

pip install -e .

Alternatively, you can also install ShowerModel (using conda-build) by running the following command from the ShowerModel root directory:

conda develop .

Test your installation by running any of the notebooks in this repository. Otherwise open an Issue with your error.

Installation, versioning and docs-web deploying methods are base on the ctapipe repository.

Further information

See our poster and presentation video from ADASS XXX conference https://adass2020.es/:

Project details


Download files

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

Source Distribution

ShowerModel-0.1.3.tar.gz (2.7 MB view hashes)

Uploaded Source

Built Distribution

ShowerModel-0.1.3-py3-none-any.whl (64.3 kB view hashes)

Uploaded Python 3

Supported by

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