Difference between revisions of "Getting started"

From MKMCXX
Jump to: navigation, search
Line 10: Line 10:
  
 
==== Windows ====
 
==== Windows ====
 +
On Windows, you can perform simulations by placing these in seperate folders
  
 
==== Unix ====
 
==== Unix ====
Open a terminal and go to the folder wherein you have placed your mkmcxx executable.
+
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 <code>bin</code> and a directory named <code>example</code>. Go to the <code>example</code> directory and execute the program as follows:
  
 
<pre>
 
<pre>
cd example
+
../bin/mkmcxx -i input.mkm
../mkmcxx -i input.mkm
 
 
</pre>
 
</pre>
  
 
==== Viewing the results ====
 
==== Viewing the results ====

Revision as of 17:08, 10 July 2017

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 seperate folders

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

Viewing the results