... | ... | @@ -23,12 +23,19 @@ please visit the [Releases](https://gitlab.inria.fr/OCSR/UMANS/-/releases) page |
|
|
To compile the UMANS codebase on your machine, perform the following steps:
|
|
|
|
|
|
1. Clone or download the code from [our GitLab repository](https://gitlab.inria.fr/OCSR/UMANS/).
|
|
|
2. Download and install [Qt](https://www.qt.io/) (optional) and [CMake](https://cmake.org/) (required).
|
|
|
(Qt is only needed if you want to compile the *UMANS-GUI* application.)
|
|
|
3. Use CMake to turn the codebase into a programming project for your IDE/compiler of choice.
|
|
|
(You can also disable the UMANS-GUI project here. If you disable it, you do not need a Qt installation.)
|
|
|
4. Compile the code in your IDE/compiler.
|
|
|
This should build the three applications mentioned before.
|
|
|
2. Download and install [CMake](https://cmake.org/).
|
|
|
3. *(Optional)* Download and install [Qt](https://www.qt.io/). This is only needed if you want to compile the *UMANS-GUI* application. For first-time users, we recommend that you start *without* the GUI application (and without Qt), because most installation problems are related to Qt.
|
|
|
4. Use CMake to turn the codebase into a programming project for your IDE/compiler of choice. If you have not installed Qt, you need to disable the option UMANS_USE_GUI_APPLICATION in CMake. This will make sure that the *UMANS-GUI* project does not get created. You can always go back later to re-enable the option.
|
|
|
5. Compile the code in your IDE/compiler.
|
|
|
This should build the two or three applications mentioned before.
|
|
|
|
|
|
# Running UMANS for the first time
|
|
|
|
|
|
Once you have downloaded or compiled the binaries, the UMANS applications should be somewhere on your disk. You can then run *UMANS-ConsoleApplication* (and *UMANS-GUI*, if you have it) from the command line, or from inside your IDE (such as Visual Studio).
|
|
|
|
|
|
The *UMANS-ConsoleApplication* program has several command-line arguments, some of which are mandatory. It's easiest to first run this program without any arguments. This will print an explanation to the console, with instructions on which arguments to supply.
|
|
|
|
|
|
If you've managed to run the console application successfully, you can consider moving to the GUI. This means installing Qt, running CMake with the option UMANS_USE_GUI_APPLICATION enabled, and compiling and running the *UMANS-GUI* project. If you run into any problems here, please take a look at the "Troubleshooting" section below.
|
|
|
|
|
|
# Input and output
|
|
|
|
... | ... | |