Welcome to SimEx-Lite’s documentation!

SimEx-Lite

https://travis-ci.com/PaNOSC-ViNYL/SimEx-Lite.svg?branch=main Documentation Status

The core package of the SIMEX platform providing the calculator interfaces.

Installing

SimEx-Lite can be installed with Python 3.6 or later:

$ pip install SimEx-Lite

Developing

We encourage everyone to contribute to SimEx. For a detailed guide, please visit https://simex-lite.readthedocs.io/en/latest/contributing.html

  1. Clone this Github repository:

$ git clone --recursive git@github.com:PaNOSC-ViNYL/SimEx-Lite.git

  1. Install the package locally:

$ cd SimEx-Lite
$ pip install -e .

Tests

  1. Download the testing files.

$ cd tests
$ git clone https://github.com/PaNOSC-ViNYL/SimEx-Lite-testFiles testFiles

  1. Run the test

$ pytest .

Features

  • Provide the python interface of calculators for the SIMEX platform.

    • PhotonSourceCalculator

    • PhotonPropagationCalculator

    • PhotonMattterInteractor

    • DiffractionCalculator

    • DetectorClaculator

  • Provide data APIs for different data formats.

    • Photon beam data

    • Photon matter interaction Data

    • Diffraction data

Acknowledgement

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 823852.

Contents:

Indices and tables