Metadata-Version: 2.1
Name: ShowerModel
Version: 0.0.0
Summary: Modelling cosmic-ray showers, their light production and its detection
Home-page: https://github.com/JaimeRosado/ShowerModel
Author: Jaime Rosado
Author-email: jrosadov@ucm.es
License: GPL-3.0
Description: ShowerModel
        --------
        
        ![ShowerModel logo](docs/logo_showermodel.png)
        
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/JaimeRosado/ShowerModel/master?filepath=notebooks)
        
        [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4306356.svg)](https://doi.org/10.5281/zenodo.4306356)
        
        A Python package for modelling cosmic-ray showers, their light production and their detection.
        
        --------
        * Code : https://github.com/JaimeRosado/ShowerModel
        * Docs: https://jaimerosado.github.io/ShowerModel
        * License: GPL-3.0
        --------
        
        ## Install
        
        * Install miniconda or anaconda first.
        
        ### As user
        It can be installed by doing:
        ```
        pip install ShowerModel
        ```
        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
        ```
        
        Although it is optional, it is recommended to create a dedicated conda virtual environment.
        
        ### 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 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
        where the `setup.py` file is located:
        ```
        pip install -e .
        ```
        
        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](https://github.com/cta-observatory/ctapipe).
        
        ## Further information
        See our presentation video and poster from ADASS XXX conference https://adass2020.es/:
        * https://drive.google.com/file/d/14AGV91mQXDwecGy2qxgNEmWeIcxKy_I0/view?usp=sharing
        * https://adass2020.es/static/ftp/P4-176/P4-176.pdf
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: docs
