Difference between revisions of "Getting started"
Line 10: | Line 10: | ||
==== Windows ==== | ==== Windows ==== | ||
− | On Windows, you can perform simulations by placing these in | + | On Windows, you can perform simulations by placing these in separate folders and executing a batch file. To perform the example simulation, go to the folder where you have unpacked the software package. Open the folder <code>place_different_runs_here</code> and thereafter the folder <code>example</code>. Inside this folder, there is a file called <code>run.bat</code>; double-click on this file and the simulation should start. |
==== Unix ==== | ==== Unix ==== |
Revision as of 17:10, 10 July 2017
Contents
Getting started
Obtain the software
To get started using MKMCXX, you need to download the software package and unpack it on your machine. The package contains a single executable file. For windows, this file is called "mkmcxx.exe", for Unix this is simply "mkmcxx".
In addition to the software, you also need to obtain a text editor. On Unix systems, typically vim or nano is installed. For Windows, we recommend using Notepad++.
Running the program
Performing a simulation works somewhat different on Windows as compared to Unix. Please read the respective instructions below.
Windows
On Windows, you can perform simulations by placing these in separate folders and executing a batch file. To perform the example simulation, go to the folder where you have unpacked the software package. Open the folder place_different_runs_here
and thereafter the folder example
. Inside this folder, there is a file called run.bat
; double-click on this file and the simulation should start.
Unix
On Unix systems, simulations are typically performed using the command line. Open a terminal and go to the root folder of the MKMCXX package. In this folder, you will see a directory named bin
and a directory named example
. Go to the example
directory and execute the program as follows:
../bin/mkmcxx -i input.mkm