pixell

This is an early development repository for a CMB map analysis library. The API for core modules will likely remain the same as in amaurea/enlib, but module and repository names are very likely to change!

Free software: BSD license
Documentation: https://pixell.readthedocs.io.

Dependencies

Python>=2.7 or Python>=3.4
gcc/gfortran or Intel compilers (clang might not work out of the box)
libsharp (downloaded and installed)
automake (for libsharp compilation)
healpy, Cython, astropy, numpy, scipy, matplotlib, pyyaml, h5py

Installing

To install, run:

$ python setup.py install --user

Existing `libsharp` installation

You can use an existing libsharp installation by symlinking the libsharp directory into a directory called _deps in the root directory.

Intel compilers

Intel compilers might require a two step installation as follows

$ python setup.py build_ext -i --fcompiler=intelem --compiler=intelem
$ python setup.py install --user

Development workflow

If you are a developer, run:

$ python setup.py build_ext -i

and add the cloned directory to your Python path so that changes you make in any python file are immediately reflected. e.g., in your .bashrc file,

export PYTHONPATH=$PYTHONPATH:/path/to/cloned/pixell/directory

If you also need non-Python code to be recompiled, run:

$ python setup.py clean

before the above steps.

Contributing

If you have write access to this repository, please:

create a new branch
push your changes to that branch
merge or rebase to get in sync with master
submit a pull request on github

If you do not have write access, create a fork of this repository and proceed as described above. For more details, see :ref:`ContributingPage`.

aiolasimone/pixell