Skip to content

Getting Started

Liam edited this page Jan 28, 2023 · 7 revisions

At present, I don't distribute any precompiled binaries for the most up to date version of Pottchi, so it has to be built from source. The project ships with a CMakeLists file that most likely works on your system. Building the project optionally requires SFML, and you can find a rough build guide here.

Once you've built Pottchi, you'll find three files that will let you run a default simulation right off the bat: the binary, called "Pottchi", and two default configuration files "default.cfg" and "default.pgm". On windows, you will also need any dlls, which should be in the build folder. You can move these files anywhere you like, as long as they're all together in the same directory.

To run the default configuration, simply execute "Pottchi" or "Pottchi.exe". To run a custom simulation, provide the name of the configuration file you want to use as the first argument. For example, on Linux, if you have a simulation called "testSim.cfg", then you can run this by running "./Pottchi testSim" in the terminal.

When the simulation completes, it will create two files, both with the same name. The first is an image of the simulation in its final state, and the second is a log file, which contains any reports you requested in the config file. See here for more information on log files.

The default configuration file produces what an analogue of a human or mouse blastocyst. You can find out more about this here.

Clone this wiki locally