mkdocs.yml

site_name: OpenTrafficSim
site_url: https://opentrafficsim.org
site_favicon: images/favicon.png
copyright: (c) 2014-2024 Delft University of Technology

theme:
  name: material
  navigation_depth: 1
    
markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - toc:
      permalink: true
      baselevel: 1
      toc_depth: 3
      
extra_css: 
  - css/custom.css
  
extra_javascript:
  - js/collapse_menu.js
  - js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
    
nav:
  - Home: index.md
  - 1. Technical manual:
    - Preface: 01-technical/preface.md
    - Current developments: 01-technical/developments.md
    - Install ots for developers: 01-technical/installation-developers.md
    - Git branching and merging: 01-technical/branch-merge-developer.md
    - Publish ots: 01-technical/publish-ots.md
    - Install ots for modelers: 01-technical/installation-modelers.md
    - '→ OTS compile information': https://opentrafficsim.org/docs/latest
    - '→ ots-base Javadoc APIs': https://opentrafficsim.org/docs/latest/ots-base/apidocs
    - '→ ots-core Javadoc APIs': https://opentrafficsim.org/docs/latest/ots-core/apidocs
    - '→ ots-road Javadoc APIs': https://opentrafficsim.org/docs/latest/ots-road/apidocs
  - 2. Model structure:
    - GTU - Generalized Travel Unit: 02-model-structure/gtu.md
    - DSOL - event-based simulation: 02-model-structure/dsol.md
    - DJUTILS - Delft Java Utils: 02-model-structure/djutils.md
    - List of event types in OTS: 02-model-structure/events.md
    - DJUNITS - Delft Java Units: 02-model-structure/djunits.md
    - Java programming standards: 02-model-structure/java.md
  - 3. Network:
    - Link level: 03-network/link-level.md
    - Lane level: 03-network/lane-level.md
    - Lane-based objects: 03-network/lane-objects.md
  - 4. Traffic demand:
    - Introduction: 04-demand/introduction.md
    - Origin-destination matrix: 04-demand/od-matrix.md
    - Split fractions: 04-demand/split-fractions.md
    - GTU generators: 04-demand/gtu-generators.md
    - Generation algorithm: 04-demand/generation-algorithm.md
    - Inter-arrival time generator: 04-demand/iat-generator.md
    - GTU characteristics generator: 04-demand/gtu-characteristics.md
    - Positions: 04-demand/positions.md
    - Room checker: 04-demand/room-checker.md
    - Traffic from OD matrix: 04-demand/traffic-od.md
    - Traffic from injection: 04-demand/injections.md
  - 5. Perception:
    - Introduction: 05-perception/introduction.md
    - Headway information: 05-perception/headway.md
    - Categorical perception: 05-perception/categorial.md
    - Mental models: 05-perception/mental.md
    - Lane structure: 05-perception/lane-structure.md
    - Iterables and collectors: 05-perception/iterables-collectors.md
    - Historical information: 05-perception/historical.md
  - 6. Behavioral models:
    - Introduction: 06-behavior/introduction.md
    - Strategical planner: 06-behavior/strategical-planner.md
    - Tactical planner: 06-behavior/tactical-planner.md
    - Lane-change model: 06-behavior/lane-change.md
    - Parameters: 06-behavior/parameters.md
  - 7. Simulation output:
    - Trajectory data: 07-output/trajectory-data.md
    - Performance indicators: 07-output/indicators.md
    - Detector data: 07-output/detector-data.md
    - Custom data: 07-output/custom-data.md
  - 8. Tutorials:
    - Tutorial overview: 08-tutorials/index.md
    - Simulation setup: 08-tutorials/simulation-setup.md
    - Development: 08-tutorials/development.md
    - Visualization: 08-tutorials/visualization.md
  - 9. Troubleshooting:
    - Common issues with OTS: 09-troubleshooting/troubleshooting.md
  - 10. References:
    - Reference list: 10-references/references.md
  - Appendices:
    - A) Conflict areas: 99-appendices/conflict-areas.md
    - B) Queue spillback: 99-appendices/queue-spillback.md