Skip to content

PaNOSC-ViNYL/SimEx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0ca295e · Jan 26, 2022
Jul 11, 2019
Nov 5, 2020
Jun 22, 2021
Oct 31, 2016
Jan 26, 2022
Jan 26, 2022
Apr 14, 2020
May 19, 2016
Sep 25, 2020
Apr 14, 2020
Oct 22, 2020
Feb 5, 2016
Jun 18, 2019
Nov 6, 2020
Mar 28, 2017
Jan 19, 2021
Jun 12, 2020
Mar 8, 2021
Feb 27, 2018
Feb 17, 2021
Apr 12, 2016
Apr 12, 2016
Apr 27, 2016
Sep 23, 2020

Repository files navigation

SimEx

Software platform for Simulation of advanced photon Experiments.

Build Status master Build Status develop

Purpose of SimEx

SimEx is a python library to facilitate setup, execution, and analysis of simulations of experiments at advanced laser light sources. As an example, consider a molecule radiated by highly brilliant, ultrashort x-ray pulses such as delivered by an X-Ray Free Electron Laser (X-FEL). The simulation platform allows to combine tools and codes for the simulation of each step of the experiment: Generation of radiation in the photon source, propagation through optics and waveguides to the interaction point, photon-matter interaction, scattering of the radiation into the far field and detection of the latter. The platform provides slots and interfaces for the various simulation steps.

User manual

For more details (user manual, installation instructions, examples, etc.), please visit the project's readthedocs page at https://simex.readthedocs.io/

Install

Get source code:

git clone --depth 1 -b master https://github.com/PaNOSC-ViNYL/SimEx.git

CENTOS 8

yum install -y hdf5 hdf5-devel fftw-devel flex bison

Conda (preferred)

wget -c -O /tmp/miniconda.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
sh /tmp/miniconda.sh
  • Select a directory XX where to install miniconda, consider 5GB of free disk space.
  • Add the XX/miniconda/bin/ directory to your path
./install.sh conda-env
conda init $SHELL

restart your shell

conda activate simex
./install.sh conda

Docker image

https://github.com/PaNOSC-ViNYL/SimEx/tree/master/Docker

To run the docker image, edit run_docker.sh and run the script.

./run_docker.sh

Tutorial notebooks

https://github.com/PaNOSC-ViNYL/SimEx-notebooks

Development

The size of this Github repository of SimEx is huge due to the historical TestFiles.

This command can clone only the newest develop branch to reduce the dowloading size:

git clone --depth 1 -b develop https://github.com/PaNOSC-ViNYL/SimEx.git

Now the TestFiles are hosted at Zenodo. The files can be downloaded with this script.

Acknowledgements

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