Manual#

All public coexist subroutines are fully documented here, along with copy-pastable examples. The base functionality is summarised below; the rest of the library is organised into submodules, which you can access on the left. You can also use the Search bar in the top left to go directly to what you need.

We really appreciate all help with writing useful documentation; if you feel something can be improved, or would like to share some example code, by all means get in contact with us - or be a superhero and click Edit this page on the right and submit your changes to the GitHub repository directly!

ACCES#

Exported functionality related to the ACCES macro calibration suite.

coexist.Access(script_path[, scheduler])

Optimise an arbitrary user-defined script's parameters in parallel.

coexist.AccessData([access_path])

Access (pun intended) data generated by a coexist.Access run; read it in using coexist.AccessData.read("access_seed<seed>").

coexist.create_parameters([variables, ...])

Create a pandas.DataFrame storing Access free parameters' names, bounds, and optionally starting values and relative uncertainty.

LIGGGHTS#

Helpers for driving LIGGGHTS simulations with less code that is more memory efficient and error-proof. You need the liggghts Python interface to LIGGGHTS to be installed to use LiggghtsSimulation. The PICI-LIGGGHTS repository has instructions for this.

coexist.LiggghtsSimulation

alias of LiggghtsNotFound

coexist.Simulation()

Abstract class defining the interface a DEM simulation engine must implement to be used by the Coexist and Access algorithms.

coexist.to_vtk(dirname, positions, *[, ...])

Export particle positions and optionally times, velocities and radii to a folder dirname in the modern binary VTK format.

Submodules#

Submodules