|
|
This page explains how to download or compile the UMANS binaries, what their main input and output is, and what to do if you run into problems.
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
# Obtaining the UMANS binaries
|
|
|
|
|
|
UMANS has three main applications that you can use:
|
|
|
|
|
|
- ***UMANS-ConsoleApplication***: A command-line-only program that can run a crowd-simulation scenario and save the results.
|
|
|
If you run this program without any arguments, it will print more detailed usage instructions.
|
|
|
- ***UMANS-GUI***: A demo program with a (Qt) GUI, in which you can view a simulation and edit it with basic mouse and keyboard interaction.
|
|
|
- ***UMANS-Library***: A dynamic library (a DLL on Windows, or an .so file on Linux) with an API that can be integrated into other software.
|
|
|
|
|
|
To obtain these programs, you have two options: download the pre-built binaries, or compile the code yourself.
|
|
|
|
|
|
### Option 1: Download the binaries
|
|
|
|
|
|
For downloadable pre-built binaries of UMANS,
|
|
|
please visit the [Releases](https://gitlab.inria.fr/OCSR/UMANS/-/releases) page of this repository.
|
|
|
|
|
|
### Option 2: Compile the code
|
|
|
|
|
|
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.
|
|
|
|
|
|
# Input and output
|
|
|
|
|
|
The main **input** of a UMANS simulation is an **XML file** that describes agents, their start and goal positions,
|
|
|
their navigation behavior, and optionally obstacles.
|
|
|
Many working examples can be found in the [*examples*](https://gitlab.inria.fr/OCSR/UMANS/-/tree/master/examples) folder.
|
|
|
|
|
|
The main **output** of a UMANS simulation (or at least of the *UMANS-ConsoleApplication* program)
|
|
|
is a **folder with CSV files**, where each file contains the trajectory of one agent in the crowd.
|
|
|
You can plot these trajectories in a tool of choice.
|
|
|
You can also consider using the [ChAOS](https://gitlab.inria.fr/OCSR/ChAOS/) software
|
|
|
to visualize the results with animated 3D characters.
|
|
|
|
|
|
The *UMANS-ConsoleApplication* program simply converts input (XML) to output (CSV).
|
|
|
By contrast, *UMANS-GUI* and *UMANS-Library* are meant for interactive purposes, so they do not produce any output files by default.
|
|
|
|
|
|
# Documentation
|
|
|
|
|
|
### For end users
|
|
|
|
|
|
For general users of UMANS, the wiki that you are currently reading contains basic information on how to use the software. We will extend this wiki over time.
|
|
|
|
|
|
### For programmers
|
|
|
|
|
|
For those interested in using/extending the UMANS source code,
|
|
|
most of the codebase has been carefully documented in a style compatible with [Doxygen](http://www.doxygen.nl/).
|
|
|
This facilitates development in an IDE such as Visual Studio.
|
|
|
If you run Doxygen on the UMANS root folder, it wil generate a *html* folder with documentation.
|
|
|
(This folder is not part of the repository on purpose.)
|
|
|
|
|
|
# Troubleshooting
|
|
|
|
|
|
Do you have problems compiling or running UMANS? Our experience is that the vast majority of problems is related to Qt and Windows, where the process depends on what has already been installed on your PC. Please check CMake and your IDE for specific error messages, and try searching for them yourself in your favorite search engine. This usually leads to good suggestions for solving your specific issues.
|
|
|
|
|
|
If you really cannot find a solution yourself, you can send an e-mail
|
|
|
- to Wouter van Toll (*wouter.van-toll[at]inria.fr*) if it's a Windows issue,
|
|
|
- or to Fabien Grzeskowiak (*fabien.grzeskowiak[at]inria.fr*) if it's a Linux issue,
|
|
|
- or to both if you are not sure who to address.
|
|
|
|
|
|
However, please keep in mind that it is very difficult to solve compilation/runtime problems on someone else's machine. We cannot guarantee that we can solve your issue (let alone within a limited amount of time). Thank you in advance for understanding. |
|
|
\ No newline at end of file |