Commit f85e5f4c authored by Johannes Blaschke's avatar Johannes Blaschke
Browse files

Add README.md

parent f71f5a83
# MPICD
an MPI-enabled MPCD (multi-particle collision dynamics) simulation tool.
## Compiling
MPICD can be compiled using SCons, or using CMake
### SCons
Recommended:
```
scons --enable-interactive=True --debug-information=True --debug-compile=
```
Compile everything (including debug):
```
scons --enable-interactive=True --debug-information=True --debug-compile=True
```
Options:
`--enable-interactive=True` enables interactive mode, where a python interpreter can connect to a running simulation.
`--enable-pressure=True` enables explicit-pressure mode.
Note: turn "off" a compile-time option by leaving the argument blank. "False" won't work (I'll fix this if I hear complaints).
### CMake
Recommended
```
mkdir build
cd build
cmake -DCMAKE_ENABLE_INTERACTIVE -DCMAKE_BUILD_TYPE=Release
make -j
```
Debug mode is enabled using the `-DCMAKE_BUILD_TYPE=Debug` option.
Additional Options:
`-CMAKE_ENABLE_INTERACTIVE` enables interactive mode, where a python interpreter can connect to a running simulation.
`-DCMAKE_ENABLE_PFIELD` enables explicit-pressure mode.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment