https://github.com/zonca/ereline

Check the gainsmoothing branch
https://github.com/zonca/ereline

Last synced: 9 months ago
JSON representation

Check the gainsmoothing branch

• Host: GitHub
• URL: https://github.com/zonca/ereline
• Owner: zonca
• License: gpl-3.0
• Created: 2014-10-13T16:43:24.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-07-04T13:29:36.000Z (almost 9 years ago)
• Last Synced: 2025-01-13T10:30:58.630Z (over 1 year ago)
• Language: C++
• Homepage:
• Size: 41.9 MB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • License: COPYING

Awesome Lists containing this project

README

          
Ereline - Planck/LFI calibration pipeline for Erebor

====================================================

Introduction

------------

Ereline is a re-implementation of the Planck/LFI calibration pipeline.

It has been designed for testing different approaches in the

calibration and to checking the robustness of LFI's results.

It is written in C++ and accesses data written in FITS format. The

current plan is to simulate the following features of the instrument:

- Effect of non-ideal beams in the observation of the sky

- Presence of a Doppler effect due to the satellite's motion

- Time-dependent gain instabilities

Dependencies

------------

The code uses C++11 features, so you need a reasonably recent C++

compiler (GCC 4.8.x is ok).

The code needs the [Boost library](http://www.boost.org) to compile.

Version 1.41 is the oldest one known to be usable with Ereline. The

following modules are used:

- Boost::date_time

- Boost::format

- Boost::test (only used by "make check")

Healpix 3.x must be installed and made available to the `configure`

script. The cleanest way to do this is to specify the `CPPFLAGS` and

`LDFLAGS` variables in the command line used to invoke `configure`:

    ./configure CPPFLAGS=-I$HEALPIX/include LDFLAGS=-L$HEALPIX/lib

A MPI library is required as well. To use it, specify `CXX=mpic++` in

the invocation to "configure", just as above. (Depending on the MPI

library you're using, you might need to change `mpic++` into `mpicxx`,

`mpiCC`, or something else).

[SQLite3](http://www.sqlite.org/) and

[GNU GSL](http://www.gnu.org/software/gsl/) are two more needed

dependencies. In both cases, the `configure` script should be smart

enough to find them with no user intervention. If not, use the same

trick shown above for Healpix (i.e., `CPPFLAGS`/`LDFLAGS`).

If you want to build the Developer's manual, you need to install

Doxygen as well (http://www.stack.nl/~dimitri/doxygen).

How to compile the code

-----------------------

Download the code to some directory (e.g. `/opt/ereline`), then run

the following commands from your home directory:

    $ mkdir ereline_build

    $ cd ereline_build

    $ /path/to/ereline/source/code/configure \

        --with-boost=PATH_TO_BOOST \

        CPPFLAGS=-I$HEALPIX/include \

        LDFLAGS=-L$HEALPIX/lib CXX=mpic++

    $ make

    $ make check

(note that you do not have to run `configure` and `make` in the same

directory as the source code — this allows to keep the source in a

read-only folder.)

The last command (`make check`) is optional: it ensures that the code

works as expected by running a number of test programs and checking

that their results agrees with the expectations.

How to create the documentation

-------------------------------

The User's manual has been written using Sphinx. You will need to

install Python 2.7, the [Sphinx](http://sphinx-doc.org/) package

(under Debian/Ubuntu, run `sudo apt-get install python-sphinx`) and

the appropriate "readthedocs" style. The latter can be installed using

pip:

    $ pip install sphinx_rtd_theme

Then, enter the `doc/user_manual` and issue the command

    $ make html

The result will be placed in the directory `_build/html/`.

Unfortunately, at the time the documentation is lagging behind the

code.

Development status

------------------

Currently the program implements all the δDX11 modules used in the

calibration, i.e.:

- Projection of TODs into rings

- Dipole fitting

- Mademoiselle/DaCapo

- δDX11 smoothing

License

-------

We have still to decide which license to use. In the long run, it will

probably be an open-source license, but at the moment we want to keep

it private until the whole Planck dataset will be released to the

public.