Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.92 KB

README.md

File metadata and controls

35 lines (28 loc) · 1.92 KB

PUMAS Build codecov Documentation

( Semi Analytical MUons -or taus- Propagation, backwards )

Description

The PUMAS library allows to transport muon or tau leptons by forward or backward Monte Carlo. The library is written in C99 with the standard library as sole dependency. PUMAS is thread safe by design. The library also allows to generate stopping power tables in the Particle Data Group (PDG) format. A compilation of tables generated with PUMAS is available from the pumas-materials repository.

Installation

Building the library requires only the files pumas.h and pumas.c. On UNIX you might directly use the provided Makefile. Alternatively, or on other platforms, CMake can be used with the provided CMakeLists.txt. More detailed instructions are provided in the documentation.

Documentation

The documentation is available online from Read the Docs. It contains a description of the library API as well as tutorials. You might also directly browse the examples provided with the source.

License

The PUMAS library is under the GNU LGPLv3 license. See the provided LICENSE and COPYING.LESSER files. The examples however have a separate public domain license allowing them to be copied without any restriction.