Skip to content
Snippets Groups Projects

pipeline status coverage report

Astrotools

General description

The astrotools are a lightweight python library for physics of Ultra-high energy cosmic rays with particular focus on arrival direction tasks. We support functionalities in the following fields:

  • Coordinate transformations
  • Cosmic Ray Observables
  • Galactic magnetic field lensing
  • Setup simulations of arrival scenarios
  • Tools for the Pierre Auger Observatory

It is compatible with python2.6+ and python3.

Interface

All functions work on numpy arrays if possible

Defaults

  • energy:
    log10(E/eV)\log_{10}(E / eV)
  • charges and masses: integers Z, A
  • coordinates: Mpc, galactic coordinate system

Coordinates:

  • Cartesian: x, y, z
  • Local spherical:
    • \text{azimuth:} \; \; \phi \in [-\pi, \pi) \; \;
      with 0 pointing in x,
      \pi/2
      pointing in y direction
    • \text{zenith:} \; \; \theta \in [0, \pi] \; \;
      with 0 pointing in z direction
  • Galactic spherical:
    • \text{lon:} \; \; \ell \in [-\pi, \pi) \; \;
      with 0 pointing in x (GC),
      \pi/2
      pointing in y direction
    • \text{lat:} \; \; b \in [\pi/2, -\pi/2] \; \;
      with
      \pi/2
      pointing in z direction

Installation

You can install the astrotools via pip. Simply run:

pip install astrotools --user

If you like to have the latest version (which is not an official release version), you can clone the astrotools in a local folder and install it via pip from there:

git clone https://git.rwth-aachen.de/astro/astrotools.git
cd astrotools
pip install . --user

The astrotools require additional dependencies (numpy, matplotlib, scipy, healpy), which you can easily install via pip:

pip install numpy
pip install scipy
pip install matplotlib
pip install healpy

Getting started

We provide a small tutorial on the astrotools documentation webpage to demonstrate some of the basic astrotools functionalties: http://astro.pages.rwth-aachen.de/astrotools/tutorial.html

Documentation

For detailed documentation of the respective modules and functions, please have a look at the official astrotools documentation: http://astro.pages.rwth-aachen.de/astrotools