Tutorials

Worked simulations in order of difficulty, starting from something trivial. Each one adds exactly one new idea to the one before it, and each is a complete script you can run rather than a fragment to assemble.

Every script on these pages was run before it was written up, and the numbers quoted are the numbers it produced. Where a result is surprising, the page says so rather than leaving you to wonder whether you typed something wrong.

Two tracks

Python is the track to start with, and the difference is not a matter of taste. With the Python package installed you edit a script and run it; there is no build step between a change and a result, and the loop is a few seconds long. That is the right way to learn what the simulator does.

A C++ track covers the same ground for anyone embedding the solver in an application or writing a new model, where the Python API is not the interface being used. It costs a compile and link on every change, so it is the wrong place to learn the concepts and the right place to work once you know them. It also requires a working build of DPsim itself rather than only the installed package; see build. The C++ examples are the material it is being built from.

The two tracks describe the same simulator and share the concept pages behind them. Only the calling code differs, so nothing learned in one track has to be relearned in the other.

If a tutorial is not what you want

The User Guide covers installation and individual features, Concepts has the mathematics behind the models, the Developer Guide covers changing DPsim rather than using it, and Reference has the generated API and the model availability tables.