Metadata-Version: 1.1
Name: s4cmb
Version: 0.3.2
Summary: Simulate systematic effects in the context of CMB
Home-page: https://github.com/JulienPeloton/s4cmb
Author: Julien Peloton
Author-email: j.peloton@sussex.ac.uk
License: GPL-3.0
Download-URL: https://github.com/JulienPeloton/s4cmb/archive/0.3.2.tar.gz
Description: ================
        s4cmb (public version)
        ================
        
        .. image:: https://travis-ci.org/JulienPeloton/s4cmb.svg?branch=master
            :target: https://travis-ci.org/JulienPeloton/s4cmb
        
        .. figure:: https://github.com/JulienPeloton/s4cmb/blob/master/s4cmb/data/intro.png
            :scale: 25 %
        
        The package
        =============
        Systematics For Cosmic Microwave Background (s4cmb), is a package to
        study instrumental systematic effects in the context of current and future
        Cosmic Microwave Background experiments.
        
        Requirements
        =============
        The pipeline is mainly written in python and it has the following dependencies:
        
        * numpy, matplotlib
        * h5py (I/O)
        * astropy, ephem, pyslalib, healpy (astro libs)
        * f2py, weave (interfacing with python)
        
        While we use python 2.7, we try to make it compatible with python 3.x.
        If you are using python 3.x and you encounter an error, please open an issue or a
        pull request so that we fix it asap.
        
        Some parts of the pipeline are written in C (and compiled on-the-fly via the
        package weave), and in Fortran (to come). The latter is interfaced with
        python using f2py. The compilation is done usually when you install the
        package (see setup.py), but we also provide a Makefile for more
        customized compilations (see dir/Makefile).
        
        Installation
        =============
        Fork the repo from the github repository and clone it to your machine.
        Use the setup.py for the installation. Just run:
        
        ::
        
            python setup.py install
        
        Make sure you have correct permissions (otherwise just add --user).
        You can also directly use the code by updating manually your PYTHONPATH.
        Just add in your bashrc:
        
        ::
        
            s4cmbPATH=/path/to/the/package
            export PYTHONPATH=$PYTHONPATH:$s4cmbPATH
        
        Coming soon: pip package + dockerfile :-)
        
        Examples
        =============
        You can find notebooks describing how to use basic functionalities of s4cmb
        in the folder jupyter_doc.
        
        TODO
        =============
        
        * Add the dockerfile.
        * Link to pip.
        
        Main developers
        =============
        * Julien Peloton (j.peloton at sussex.ac.uk)
        * Giulio Fabbian (gfabbian at ias.u-psud.fr)
        
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Astronomy
