Installation of MuDirac

MuDirac uses CMake as a build system, and requires a C++ compiler. In order to compile it and prepare it to be executed on a Linux, Unix, or MacOS system with a working C++ compiler installed, follow these steps:

  1. Download and unpack (or git clone) the repository on your local system.

  2. Within the main folder of the repository (the one containing the READ.md file), create a subfolder called build.

  3. Within the build folder, run the following commands:

cmake ..
make mudirac

In order to run the test suite, within the same directory run:

make tests
make test

and wait for a few seconds for the tests to complete. If you want mudirac to be accessible from any folder in your computer, add the resulting bin directory to your system PATH environment variable.

Usage

MuDirac works simply by running it with an input file:

mudirac input.in

where .in file can have any name one prefers. The input file is a text file containing rows of the form keyword: value. A full list of keywords employable in the .in file and their meaning can be found in Input keywords.