Metadata-Version: 2.1
Name: lklcom
Version: 0.5.2
Summary: LikelihoodCombiner combines DM-related likelihoods from different experiments.
Home-page: https://github.com/TjarkMiener/likelihood_combiner
Author: Tjark Miener
Author-email: tmiener@ucm.es
License: GPL-3.0
Description: 
        LlkCom: Combining likelihoods from different experiments.
        =========================================================
        
        
        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4450513.svg
           :target: https://doi.org/10.5281/zenodo.4450513
           :alt: DOI
        
        .. image:: https://travis-ci.com/TjarkMiener/likelihood_combiner.svg?branch=master
           :target: https://travis-ci.com/TjarkMiener/likelihood_combiner.svg?branch=master
        
        .. image:: https://readthedocs.org/projects/lklcom/badge/?version=latest
            :target: https://lklcom.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://anaconda.org/tmiener/likelihood_combiner/badges/installer/conda.svg
           :target: https://anaconda.org/tmiener/likelihood_combiner
           :alt: Anaconda-Server Badge
        
        .. image:: https://img.shields.io/pypi/v/lklcom
            :target: https://pypi.org/project/lklcom/
            :alt: Latest Release
        
        .. image:: https://anaconda.org/tmiener/likelihood_combiner/badges/license.svg
           :target: https://anaconda.org/tmiener/likelihood_combiner
           :alt: Anaconda-Server Badge
        
        .. figure::  https://github.com/TjarkMiener/likelihood_combiner/blob/master/images/Gloryduck_logo.png
           :alt: Gloryduck logo
        
        
        **LikelihoodCombiner** is a package under active development to combine likelihoods from different experiments. The main target of this package is the **Gloryduck** project. This project joint analysis of gamma-ray data from `\ *Fermi*\ -LAT <https://glast.sites.stanford.edu/>`_\ , `HAWC <https://www.hawc-observatory.org/>`_\ , `H.E.S.S. <https://www.mpi-hd.mpg.de/hfm/HESS/>`_\ , `MAGIC <https://magic.mpp.mpg.de/>`_ and `VERITAS <https://veritas.sao.arizona.edu/>`_ to search for gamma-ray signals from dark matter annihilation in dwarf satellite galaxies.
        
        ----
        
        
        * Code : https://github.com/TjarkMiener/likelihood_combiner
        * Documentation : https://lklcom.readthedocs.io/en/latest/ 
        * Author contact: Tjark Miener - tmiener@ucm.es
        * License: GPL-3.0
        
        ----
        
        Clone Repository with Git
        ^^^^^^^^^^^^^^^^^^^^^^^^^
        
        Clone the LikelihoodCombiner repository:
        
        .. code-block:: bash
        
           cd </installation/path>
           git clone https://github.com/TjarkMiener/likelihood_combiner
        
        Install Package with Anaconda/pypi
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        Next, download and install `Anaconda <https://www.anaconda.com/download/>`_\ , or, for a minimal installation, `Miniconda <https://conda.io/miniconda.html>`_. Create a new conda environment that includes all the dependencies for LikelihoodCombiner:
        
        .. code-block:: bash
        
           conda env create -f </installation/path>/likelihood_combiner/environment.yml
        
        Finally, install LikelihoodCombiner into the new conda environment with pip:
        
        .. code-block:: bash
        
           conda activate lklcom
           cd </installation/path>/likelihood_combiner
           pip install --upgrade .
        
        Or install LikelihoodCombiner via pypi (tested for Linux users):
        
        .. code-block:: bash
        
           conda activate lklcom
           pip install lklcom
        
        NOTE for developers: If you wish to fork/clone the respository and make changes to any of the LikelihoodCombiner modules, the package must be reinstalled for the changes to take effect.
        
        Installing as a conda package
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        To install it as a conda package, first install Anaconda by following the instructions here: https://www.anaconda.com/distribution/.
        
        Then, create and enter a new Python3 environment with:
        
        .. code-block:: bash
        
           conda create -n [ENVIRONMENT_NAME]
           conda activate [ENVIRONMENT_NAME]
        
        From the environment, add the necessary channels for all dependencies:
        
        .. code-block:: bash
        
           conda config --add channels conda-forge
           conda config --add channels menpo
        
        Install the package:
        
        .. code-block:: bash
        
           conda install -c tmiener likelihood_combiner
        
        This should automatically install all dependencies (NOTE: this may take some time, as by default MKL is included as a dependency of NumPy and it is very large).
        
        If you want to import any functionality from LikelihoodCombiner into your own Python scripts, then you are all set. However, if you wish to make use of any of the scripts in likelihood_combiner/scripts (like {local/cluster}.py), you should also clone the repository locally and checkout the corresponding tag (i.e. for version v0.5.2):
        
        .. code-block:: bash
        
           git clone https://github.com/TjarkMiener/likelihood_combiner
           git checkout v0.5.2
        
        LikelihoodCombiner should already have been installed in your environment by Conda, so no further installation steps (i.e. with setuptools or pip) are necessary and you should be able to run scripts/{local/cluster}.py directly.
        
        Dependencies
        ^^^^^^^^^^^^
        
        
        * Python3
        * Jupyter
        * NumPy
        * SciPy
        * Pandas
        * PyTables
        * PyYAML
        * Matplotlib
        
        Run the Combiner
        ----------------
        
        Run LikelihoodCombiner from the command line:
        
        .. code-block:: bash
        
           LikelihoodCombiner_dir=</installation/path>/likelihood_combiner
           python $LikelihoodCombiner_dir/scripts/{local|cluster}.py $LikelihoodCombiner_dir/config/example_config.yml
        
        Mock data
        ^^^^^^^^^
        
        The data you can find in the LikelihoodCombiner, where produced with `gLike <https://github.com/javierrico/gLike/>`_ using the `mock data <https://github.com/javierrico/gLike/tree/master/data>`_. These txt files **don't** correspond to IACT observations of Segue 1 or Ursa Major II and are only included for testing the code framework.
        
        Uninstall LikelihoodCombiner
        ----------------------------
        
        Remove Anaconda Environment
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        First, remove the conda environment in which LikelihoodCombiner is installed and all its dependencies:
        
        .. code-block:: bash
        
           conda remove --name lklcom --all
        
        Remove LikelihoodCombiner
        ^^^^^^^^^^^^^^^^^^^^^^^^^
        
        Next, completely remove LikelihoodCombiner from your system:
        
        .. code-block:: bash
        
           rm -rf </installation/path>/likelihood_combiner
        
Platform: UNKNOWN
Description-Content-Type: text/x-rst
