The SatAndLight package offers a set of C++ classes to describe scientific instruments embarked on a satellite and simulate a sequence of astrophysical observations. Single elements are simulated separately: satellite attitude and time, telescope elements (optics, geometry, camera...), sources of high-energy photons, etc... They are represented as C++ classes with associated methods. Taking advantage of the C++ class inheritance, these elements can be combined altogether to simulate an end-to-end observation sequence of astrophysical objects. A SatAndLight observation sequence can be saved on disk and be replayed as an input for analysis tools. For this purpose, the SatAndlight packge provides user interfacing methods. Finally, the SatAndLight package includes high-level and highly configurable user programs to generate a full sequence of observation.

Getting started

You can get a development copy of the SatAnLight software suite from git via:

git clone git@gitlab.in2p3.fr:SVOM/SatAndLight.git

The SatAndlight package relies on several external packages:

CMT is used as a configuration tool to manage package dependencies. After CMT is installed, the SatAndLight package must be included in the CMTPATH.
ROOT libraries are used for plotting and data management. ROOT must be installed including cfitsio-devel and fftw-devel libraries. The ROOTSYS environement variable must be defined
GSL libraries are used for numerical calculation. GSL must be installed on your machine.

It is recommended to install SatAndLight with CMT to manage package dependencies. The instructions given in this page are only valid for a CMT-based installation. SatAndLight releases are tagged as vXrYpZ. It is recommended to use the most recent version. The CMT installation of SatAndLight is straight-forward provided that the requirements are met. Go to the cmt/ directory of SatAndLight and type:

cmt config
make

Then you need to configure your environment every time you want to use SatAndLight:

source cmt/setup.(c)sh

Building SatAndLight

In this section we give step-by-step instructions to build SatAndLight for UNIX (bash/sh) systems.

# create software directory
mkdir Soft; cd ./Soft

# create environment file (to be sourced for every session)
echo "source `pwd`/CMT/v1r26p20160527/mgr/setup.sh" > ./env.sh
echo "CMTPATH=`pwd`" >> ./env.sh
echo "export CMTPATH" >> ./env.sh

# install root following the instructions given in https://root.cern.ch/
# and source your 'thisroot.sh' to update your environment

# add root in your environment script
echo "source ${ROOTSYS}/bin/thisroot.sh" > ./env.sh

# download and install CMT
wget http://www.cmtsite.net/v1r26p20160527/CMTv1r26p20160527.tar.gz
tar -xzf CMTv1r26p20160527.tar.gz; rm -f CMTv1r26p20160527.tar.gz
cd CMT/v1r26p20160527/mgr/
./INSTALL
source setup.sh
make
cd ../../..

# source environment
source ./env.sh

# download and compile SatAndLight
mkdir SatAndLight; cd SatAndLight
git clone https://gitlab.in2p3.fr/SVOM/SatAndLight.git v0
cd v0/cmt
cmt config
source setup.sh
make

# update environment file
cd ../../..
echo "source `pwd`/SatAndLight/v0/cmt/setup.sh" >> ./env.sh

Program documentation

map-sequence.exe program used to generate an observation sequence as a list of pixel maps associated to a telescope.

Authors

Florent Robinet - Laboratoire de l’accélérateur linéaire (LAL) Orsay, France - contact

Contributors

Shaymaa Hussein