@@ -17,6 +17,20 @@ Some parts of the project may still use this old name.
Since 2020, the term "OCSR" refers to the collective of open crowd-simulation resources developed at Inria Rennes.
These resources include UMANS (a simulation engine) and ChAOS (a visualization application).
# Reference
The UMANS software has been described in the following scientific publication:
> Wouter van Toll, Fabien Grzeskowiak, Axel López, Javad Amirian, Florian Berton,
> Julien Bruneau, Beatriz Cabrero Daniel, Alberto Jovane, Julien Pettré.
>
> [*"Generalized Microscopic Crowd Simulation using Costs in Velocity Space"*](https://project.inria.fr/crowdscience/generalized-microscopic-crowd-simulation-using-costs-in-velocity-space-i3d-2020/).
>
> In ACM SIGGRAPH Symposium on Interactive 3D Graphics and Games, 2020.
Please cite this publication when referring to UMANS in your work.
# Getting started
To start using UMANS, perform the following steps:
...
...
@@ -24,17 +38,21 @@ To start using UMANS, perform the following steps:
1. Clone or download the code from [our GitLab repository](https://gitlab.inria.fr/OCSR/UMANS/).
2. Download and install [CMake](https://cmake.org/).
3. Use CMake to turn the codebase into a programming project for your IDE/compiler of choice.
(This step only succeeds if the libraries from step 2 have been properly installed.)
4. Compile the code in your IDE/compiler.
This should build two applications (see the [Main projects](#main-projects) section).
5. Test the UMANS console application by running it from the command line, with the desired arguments.
If you run the program without any arguments, it will print more detailed usage instructions.
6. Inspect the CSV files that the application has produced as output.
Each CSV file contains the trajectory of one agent in the crowd.
You could consider using the [ChAOS](https://gitlab.inria.fr/OCSR/ChAOS/) software to visualize the crowd in 3D.
# Main projects
In the source code of UMANS, the simulation engine itself is contained in a static library named *Engine*.
This library can be used to compile two main applications:
-*OCSR-ConsoleApplication*: A command-line-only program that can run a crowd-simulation scenario and report the results in various ways.
-*OCSR-Library*: A dynamic library with an API that can be integrated into other software (e.g. as a DLL).
-*UMANS-ConsoleApplication*: A command-line-only program that can run a crowd-simulation scenario and report the results in various ways.
-*UMANS-Library*: A dynamic library with an API that can be integrated into other software (e.g. as a DLL).
# Third-party code / licenses
...
...
@@ -48,6 +66,10 @@ UMANS includes the following third-party code: