Documentation

Online Documentation

Quickstart

New users should follow these steps to get ESPResSo running:

  1. Check the installation requirements for your operating system
  2. Download ESPResSo
  3. Build ESPResSo
  4. Run your script with ./pypresso <SCRIPT>

Tutorials

The tutorials are available as Jupyter notebooks:

  • Introductory tutorials
    • Simulate a simple Lennard-Jones liquid 
      Modelling of a single-component and a two-component Lennard-Jones liquid.
      Guide
    • Visualization
      Using the online visualizers of ESPResSo
      Guide
  • Intermediate tutorials
  • Advanced tutorials
    • Active matter
      Modelling of self-propelling particles.
      Guide | Exercises | Solutions
    • Electrokinetics
      Modelling electrokinetics together with hydrodynamic interactions.
      Guide
    • Constant pH method
      Modelling an acid dissociation curve using the constant pH method.
      Guide

All tutorials can also be found in doc/tutorials/ in the source code and distribution packages or online on GitHub.

Further documentation