Welcome to SimEx-Lite’s documentation!

Quickstart

https://img.shields.io/pypi/v/SimEx-Lite.svg https://travis-ci.com/PaNOSC-ViNYL/SimEx-Lite.svg?branch=main Documentation Status

SimEx-Lite is the core package of the SIMEX platform providing the calculator interfaces and data APIs.

Installing

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

$ pip install SimEx-Lite

To test the latest updates, install from sources as shown below.

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. Enable the testFiles submodule.

$ git submodule init
$ git submodule update

  1. Run the test

$ pytest .

Features

SimEx-Lite provides

  • python interfaces for SIMEX backengines (aka “Calculators”)

    • SourceCalculators

    • PropagationCalculators

    • PMICalculators (PhotonMattterInteractionCalculators)

    • DiffractionCalculators

    • DetectorCalculators

  • data APIs for different data formats.

    • PMI (Photon matter interaction) data

    • Wavefront data

    • Diffraction data

Acknowledgements

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.

Introduction

Users

Developers

Indices and tables