Arti

<div id="top"></div> <br /> <div align="center"> <a href="https://github.com/lagoproject/arti"> <img src="./docs/images/lago-logo.png" alt="Logo" width="140"> </a> <h3 align="center">The ARTI Framework</h3> <p align="center"> A framework designed to simulate the signals produced by the secondary particles emerging from the interaction of the flux of primary cosmic ray with the atmosphere. These signals are simulated for any particle detector located at any place (latitude, longitude and altitude), including the real-time atmospheric, geomagnetic and detector conditions. <br /> <!-- <a href="https://github.com/lagoproject/arti"><strong>Explore the docs (soon) »</strong></a> <br /> --> <br /> <!-- <a href="https://github.com/lagoproject/arti/issues">View Demo</a> · --> <a href="https://github.com/lagoproject/arti/issues">Request Feature</a> · <a href="https://github.com/lagoproject/arti/issues">Report Bug</a> · <a href="#Contact">Contact us</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <br /> <ol> <li><a href="#about-arti">About ARTI</a></li> <li><a href="#getting-started">Getting Started</a></li> <li><a href="#usage">Usage</a></li> <li><a href="#related-projects">Related projects</a></li> <li><a href="#proposed-features">Proposed Features</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

About ARTI

<!-- <style> html, body {height: 100%;} img { height: auto; width: auto; } img.rel { width: 33%; } </style> -->

<img class="rel" src="./docs/images/flux-chacaltaya.png" alt="The seconday particle flux at Chacaltaya" width="200"><img class="rel" src="./docs/images/geomagnetic.png" alt="Charged particles trajectories" width="200"><img class="rel" src="./docs/images/wcd-muon.png" alt="A muon traversing the WCD " width="200">

ARTI is a complete framework designed to simulate the signals produced by the secondary particles emerging from the interaction of singles, multiple and even the complete flux of primary cosmic rays with the atmosphere. These signals are simulated for any particle detector located at any place (latitude, longitude and altitude), including the real-time atmospheric, geomagnetic and detector conditions.

Formulated through a sequence of scripts coded in C++, Fortran, and Perl, it provides an easy-to-use integration of three different simulation environments: Magneto Cosmics, CORSIKA and Geant4. These tools evaluate the geomagnetic field effects on the primary flux, the atmospheric showers of cosmic rays and the detectors' response to the secondary flux of particles produced in the atmosphere.

With ARTI it is also possible to calculate the flux of the expected signals produced by the sudden occurrence of a gamma-ray bursts or the flux of energetic photons originating in steady gamma sources. It also compares these fluxes with the expected background to detect these phenomena in a single water Cherenkov detector (WCD).

Even more, by using ARTI, it is possible to calculate in a very precise way the expected flux of high energetic muons and other secondaries on the ground and to inject it over a geological structure for muography applications.

ARTI main reference and citation

When using ARTI, please cite the reference reported below:

Christian Sarmiento-Cano, Mauricio Suárez-Durán, Rolando Calderón-Ardila, Adriana Vásquez-Ramírez, Andrei Jaimes-Motta, Luis A. Núñez, Sergio Dasso, Iván Sidelnik and Hernán Asorey (for the LAGO Collaboration), "The ARTI Framework: Cosmic Rays Atmospheric Background Simulations", European Journal of Physics C, 82, 1019 (2022), arXiv:2010.14591[astro-ph.IM], doi:10.1140/epjc/s10052-022-10883-z. (bibtex)

<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

System requirements

ARTI runs in any Linux based system, including iOS. For Windows user, we strongly recommend to install some of your preferred linux distribution using virtualbox. Additionally, we are developing a docker-based ARTI implementation.

In Fedora, Scientific Linux and CentOS, use sudo yum install <package>. In Ubuntu/Debian, use sudo apt install <package>. In both cases, you can also use the graphic package manager included in your preferred distro.

ARTI requires the installation of the following packages:

• bash
• perl 5.0
• perl LWD::simple module
• perl JSON module
• gcc
• make
• screen
• rsync
• git

As a one-liner for Ubuntu/Debian:

sudo apt install build-essential perl screen rsync git

(git is optional).

Dependencies

Additionally, ARTI depends on the previous installation of the following frameworks:

• CORSIKA v7.7402.
• ROOT v6.20.08.
• Magneto Cosmics v2.0.
• Geant v4.10.03.p03
• Geant v4.10.03 Data Libraries

Plese notice this list corresponds to the set of external dependencies of ARTI v1r9. Backward compatibility within previous minor versions and patches of the external dependencies is assured, i.e., ARTI will run with any older versions of CORSIKA v7.xxxx, ROOT v6.xx.xx and GEANT4.10.xx.xx.pxx.

CORSIKA should be compiled with the following options:

Compiler: 64bits 
High Energy Hadronic Model: QGSJETII-04
Low Energy hadronic interaction model: GHEISHA 2002d
Detector Geometry: non-flat (Volume) detector

and, for production, the following additional program options:

Landau-Pomeranchunk-Migdal (LPM) effect
Curved atmosphere version
external atmosphere functions
EFIELD

Additionally, ARTI is compatible with some other CORSIKA functionalities, such as PLOTSH, PLOTSH2. and CHERENKOV, but it is not recommended to compile CORSIKA using these options as they will strongly decrease the simulation performance and are not needed for production. A pre-compiled version of CORSIKA intended for simulation production is available upon request.

There are no other special requirements for ROOT, MAGNETOCOSMICS and GEANT4. Standard installations of these packages will smoothly work with ARTI.

Installation

1. If you are using git, just clone this repository:

   cd /path/to/ARTI/installation
   git clone https://github.com/lagoproject/arti.git
   

   Otherwise, you can also directly download ARTI without using git (in this case, you should reinstall ARTI for every upgrade):

   cd /path/to/ARTI/installation
   wget -c https://github.com/lagoproject/arti/archive/refs/heads/master.zip
   unzip master.zip
   rm master.zip
   

2. ARTI compiling is very simple:

   cd arti
   make
   

   1. During the first installation of ARTI (or if you need to install ARTI in a different directory), make will define the $ARTI environment variable, that points to the ARTI current directory installation. Then, ARTI installer will add the definition of this variable to the user's local .bashrc and to the local $PATH environment variable:

      #
      ## Changes added by the ARTI suite on <installation date>
      #
      export ARTI="/path/to/ARTI/installation/arti"
      export PATH="${ARTI}/sims/:${ARTI}/analysis:$PATH"
      

      You can edit your .bashrc to add, e.g., the directory where the CORSIKA executables files were located, for example:

      export CRK="/path/to/CORSIKA/run"
      export PATH="${CRK}/:$PATH"
      

If you follow the above described steps and everything works well, you should find some new executable files at the ${ARTI}/analysis directory.

Pre-compiled ARTI framework (inc. dependencies)

A Docker container having all the ARTI requirements and dependencies installed and configured with the corresponding options for production is currently under development and will be available in June 2022.

If you want to receive information about the ARTI new releases, or have any doubts or require extra information about the compiling options for all these packages, please don't hesitate to contact us.

<p align="right">(<a href="#top">back to top</a>)</p>

ARTI updates, releases, branchs and tags

ARTI is continously used, revised and updated within the LAGO Collaboration.

Unless you are a developer, we recommend to use only the latest ARTI release contained in the master branch of this repository. Stable versions are tagged and can be found in the corresponding section of this repository.

Clone and install ARTI from dev or dev-* branches is strongly discouraged, as these branches are used for testing, bug correction and for the development of new features.

If you are using git, you can update ARTI just by doing:

cd /path/to/ARTI/installation/arti
git pull
make

Otherwise, you could just reinstall ARTI by following the installation guide.

<p align="right">(<a href="#top">back to top</a>)</p>

Usage

The ARTI approach for calculation the expected flux of signals due to the integrated flux of cosmic rays is based on three stages:

1. Definition of the site characteristics, primary spectrum calculations and [