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
- Clone this Github repository:
$ git clone --recursive git@github.com:PaNOSC-ViNYL/SimEx-Lite.git
- Install the package locally:
$ cd SimEx-Lite
$ pip install -e .
Tests
- Enable the testFiles submodule.
$ git submodule init
$ git submodule update
- 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.