mraue / a3p2 Goto Github PK

======================================
Astro Particle Physics Python [A3P] II

============
Introduction

Astro Particle Physics Python II (A3PII) is a set of programs and tools
to calculate the meta-galactic radiation fields and its attenuation effect
on very high energy gamma-rays via forward folding from a star formation
history and stellar evolution emission models.

PLEASE NOTE: This is a legacy release. It is no longer developed further 
and provided as is.

If you are using this code for a publication please consider citing this
work:

  "Probing the peak of the star formation rate density with the extragalactic background light"
  Raue, Martin; Meyer, Manuel
  Monthly Notices of the Royal Astronomical Society, Volume 426, Issue 2, pp. 1097-1106.
  http://adsabs.harvard.edu/abs/2012MNRAS.426.1097R

============
Requirements

Required modules:
  - numpy
  - scipy
  - pyfits
  - matplotlib

In addition spectra from stellar population modeling (e.g. Starburst 99)
are needed as input for the EBL modeling.

For installation git is recommended

=====
Usage

Make sure to fulfill the requirements.

(1) Download a3p2 from github:
    - Create a directory for a3p2
        $ mkdir <your_a3p2_directory>
    - Enter the directory
        $ cd <your_a3p2_directory>
    - Clone from github
        $ git clone [email protected]:mraue/a3p2.git
      or download and unzip
        https://github.com/mraue/a3p2/archive/master.zip

(2) Add directory to python path:
    export PYTHONPATH=$PYTHONPATH:<your_a3p2_directory>

(3) Test the installation
    - Enter the installation directory
        $ cd <your_a3p2_directory>
    - Test drawing the EBL limit collection:
        $ python scripts/draw_ebl_measurements.py
      If everything went well you should see a plot with
      EBL limits. If not please check the output for errors.
    - Test the EBL model calculation:
        $ python scripts/calculate_ebl_model.py config/TRY_ME_FIRST_EBL.cfg.py
      This should take some time to calculate. In the end you should
      end up with a plot of the EBL model.
      Run the script without command line parameters to see further options.

(4) Next steps
    - Study the terminal output of calculate_ebl_model.py
    - Study config/TRY_ME_FIRST_EBL.cfg.py
    - Study a3p2/ebl/model.py
    - Run python scripts/plot_ebl_model_sfr.py config/TRY_ME_FIRST_EBL.cfg.py
    - Run calculate_ebl_model.py and create an output file
    - Take a look at the output file (fits)
    - Run scripts/calculate_ebl_attenuation.py

=======
LICENSE

A3P II is distributed under the Modified BSD License.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the A3P II developers nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE PYFACT DEVELOPERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

end.