SimEx-Lite 1.0.0

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

Quickstart

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

• Free software: GNU General Public License v3

• Documentation: https://SimEx-Lite.readthedocs.io

• GitHub: https://github.com/PaNOSC-ViNYL/SimEx-Lite

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 [e-mail]:PaNOSC-ViNYL/SimEx-Lite.git

2. Install the package locally:

$ cd SimEx-Lite
$ pip install -e .

Tests

1. Enable the testFiles submodule.

$ git submodule init
$ git submodule update

2. Run the test

$ pytest .

Features

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

  • SourceCalculators

  • PropagationCalculators

  • PMICalculators (PhotonMattterInteractionCalculators)

  • DiffractionCalculators

  • DetectorClaculators

• Provide data APIs for different data formats.

  • PMI (Photon matter interaction) Data

  • Wavefront 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.

History

1.0.0 (2022-09-27)

• Refactor based on libpyvinyl.

• Support instrument class.

• Updated documents for backengines installation.

0.3.4 - 0.3.7 (2022-09-19)

• Support for the legacy DiffractionData class.

0.3.3 (2022-08-05)

• Fixed reading singfel rewrited data.

• Add chunk functions to GaussianNoiseCalculator.

0.3.2 (2021-10-20)

• Included utils as a subpackage.

0.3.1 (2021-09-29)

• Updated the interface of data APIs. Details at this PR link.

• Updated the deployment guide for PyPI in CONTRIBUTING.

0.2.1 (2021-04-19)

• Deploy PyPI with Travis

0.2.0 (2021-04-17)

• Data API:

  • Added: PhotonBeamData.py

  • Added: SampleData.py

  • Added: DiffractionData.py

  • Added Singfel Diffraction data API

  • Added EMC photon data API

• Calculator:

  • Detector calculators:

    • Added Gaussian noise calculator

• Examples:

  • Added singfel2EMC data analysis example

0.1.0 (2021-02-24)

• First release on PyPI.