Welcome to Parabellum's Documentation
=====================================

Parabellum: Ultra-Scalable Warfare Simulation Engine
----------------------------------------------------

Parabellum is an advanced, high-performance warfare simulation engine developed with funding from Armasuisse. Built upon JaxMARL's SMAX environment, Parabellum has been extensively modified to support a wide range of features crucial for realistic military simulations.

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   installation

.. toctree::
   :maxdepth: 2
   :caption: API Reference

.. toctree::
   :maxdepth: 1
   :caption: Development

Features
--------

- Obstacles and terrain integration
- Rasterized maps for detailed environments
- Realistic blast radii simulation
- Friendly fire mechanics
- Pygame visualization for real-time monitoring
- Interactive Pygame interface for user engagement

Quick Start
-----------

To get started with Parabellum, install it using pip:

.. code-block:: bash

   pip install parabellum

For more detailed installation instructions and usage examples, please refer to the :doc:`installation`.

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`