Welcome to CMInject’s documentation!

GitHub Repository: https://github.com/CFEL-CMI/cminject

CMInject is a Python3 framework that can be used to define and run nanoparticle trajectory simulations. It can run 1D, 2D and 3D (or other) simulations, given that all parts in a simulation setup allow the given dimensionality.

It is meant to be used by different groups of people and match different needs, and so it is meant to be all of the following:

  • a library that provides a generic way to define and run simulations of experimental setups

  • a collection of such setups

  • a collection of executables and library code for processing, analyzing and visualizing simulation results

If you want to use CMInject for defining and running your own virtual experiments, please refer to the CMInject User guide. If you also want to add experiments that other people can use as well, or want to develop CMInject further, please refer to the CMInject Developer Guide.

Contents:

Indices and tables