The LEMONS documentation

Welcome to the official LEMONS package documentation! This guide provides comprehensive instructions on how to install and use the package. It also offers an overview of the package’s functionalities and capabilities, complemented by an extensive API reference.

GET PACKAGE

• Installation guide
  • Python wrapper
  • C++ library (CrowdMechanics)
• Source
  • Authors
  • Affiliation
  • Citation
• Contributing
  • Simple procedure
  • General procedure
  • Working on the Python wrapper
  • Working on the C++ mechanical layer
  • Continuous Integration (CI)
  • Reporting issues and proposing changes

TUTORIALS

• Minimal crowd simulation example
  • 1. Export crowd configuration files
  • 2. Set the working environment
  • 3. Build the C++ project
  • 4. Run a series of simulations
  • 5. Export to ChAOS
  • 6. Export scene snapshots as PNG images
  • 7. Export to a movie with FFMPEG
  • 8. Export to PedPy
• Configuration files
  • Create a crowd of pedestrians from the ANSURII dataset
  • Create a crowd of pedestrians with custom statistics
  • Create a 2D pedestrian
  • Create a 3D pedestrian
  • Read the ANSURII database
  • Read the configuration files
• Mechanical layer
  • Tutorial for the CrowdMechanics engine
  • How to run CrowdMechanics
  • How to test CrowdMechanics

API REFERENCE

• Configuration files (Python)
  • data
  • models
  • utils
  • backup
• Streamlit app (Python)
  • app
  • plot
  • tabs
  • utils
• Mechanical layer (C++)
  • Class Hierarchy
  • File Hierarchy
  • Full API
• Tests
  • Configuration files (Python)
  • Mechanical layer (C++)