Update 0.13.0

v0.13.0/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c9155017d04c6a77d7c6476628b8d290
+tags: 645f666f9bcd5a90fca523b33c5a78b7

v0.13.0/_sources/api/aabb/index.rst

@@ -0,0 +1,39 @@
+:py:mod:`aabb`
+==============
+
+.. py:module:: aabb
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   aabb.AABB
+
+
+
+
+.. py:class:: AABB(*, xmin: float, xmax: float, ymin: float, ymax: float)
+
+
+   .. py:property:: width
+      :type: float
+
+
+   .. py:property:: height
+      :type: float
+
+
+   .. py:property:: center
+      :type: tuple[float, float]
+
+
+   .. py:method:: combine(aabb, *other)
+      :staticmethod:
+
+
+

v0.13.0/_sources/api/agent/index.rst

@@ -0,0 +1,41 @@
+:py:mod:`agent`
+===============
+
+.. py:module:: agent
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   agent.Agent
+
+
+
+
+.. py:class:: Agent(backing)
+
+
+   .. py:property:: id
+
+
+   .. py:property:: journey_id
+
+
+   .. py:property:: stage_id
+
+
+   .. py:property:: position
+
+
+   .. py:property:: orientation
+
+
+   .. py:property:: model
+
+
+

v0.13.0/_sources/api/geometry/index.rst

@@ -0,0 +1,62 @@
+:py:mod:`geometry`
+==================
+
+.. py:module:: geometry
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   geometry.Geometry
+   geometry.GeometryBuilder
+
+
+
+
+.. py:class:: Geometry(obj: py_jupedsim.Geometry)
+
+
+   Geometry object for simulations.
+
+   .. py:method:: boundary() -> list[tuple[float, float]]
+
+
+   .. py:method:: holes() -> list[list[tuple[float, float]]]
+
+
+
+.. py:class:: GeometryBuilder
+
+
+   .. py:method:: add_accessible_area(polygon: list[tuple[float, float]]) -> None
+
+      Adds an area which can be accessed by the agents to the geometry.
+
+      Args:
+          polygon (list[tuple[float, float]]): list of x,y coordinates of
+              the points of a polygon
+
+
+   .. py:method:: exclude_from_accessible_area(polygon: list[tuple[float, float]]) -> None
+
+      Marks an area as un-accessible by the agents to the geometry.
+
+      Args:
+          polygon (list[tuple[float, float]]): list of x,y coordinates of
+              the points of a polygon
+
+
+   .. py:method:: build() -> Geometry
+
+      Builds a Geometry from the given accessible and un-accessible areas.
+
+      Returns:
+          Geometry object
+
+
+

v0.13.0/_sources/api/grid/index.rst

@@ -0,0 +1,50 @@
+:py:mod:`grid`
+==============
+
+.. py:module:: grid
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   grid.Grid
+
+
+
+
+.. py:class:: Grid(box, distance_to_agents)
+
+
+   Class to save points and check for neighbours within a radius
+
+   box : an Axis Aligned Bounding Box where the Grid will be able to save points
+   distance_to_agents : radius in which points are searched for
+
+   .. py:method:: append_point(pt)
+
+
+   .. py:method:: get_samples()
+
+      returns a copy of the samples saved
+
+
+   .. py:method:: get_cell_coords(pt)
+
+      Get the coordinates of the cell that pt = (x,y) falls in.
+      box is bounding box containing the minimal/maximal x and y values
+
+
+   .. py:method:: no_neighbours_in_distance(pt)
+
+
+   .. py:method:: has_neighbour_in_distance(pt, coords)
+
+      "returns true if there is any point in grid with lt or equal the distance `agent radius` to `pt`
+
+
+

v0.13.0/_sources/api/index.rst

@@ -0,0 +1,22 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /api/jupedsim/index
+   /api/agent/index
+   /api/geometry/index
+   /api/journey/index
+   /api/library/index
+   /api/models/index
+   /api/routing/index
+   /api/simulation/index
+   /api/stages/index
+   /api/tracing/index
+   /api/aabb/index
+   /api/grid/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

v0.13.0/_sources/api/journey/index.rst

@@ -0,0 +1,46 @@
+:py:mod:`journey`
+=================
+
+.. py:module:: journey
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   journey.Transition
+   journey.JourneyDescription
+
+
+
+
+.. py:class:: Transition(backing)
+
+
+   .. py:method:: create_fixed_transition(stage_id)
+      :staticmethod:
+
+
+   .. py:method:: create_round_robin_transition(stage_weights: list[tuple[int, int]])
+      :staticmethod:
+
+
+   .. py:method:: create_least_targeted_transition(stage_ids: list[int])
+      :staticmethod:
+
+
+
+.. py:class:: JourneyDescription(stage_ids: Optional[list[int]] = None)
+
+
+   .. py:method:: add(stages: int | list[int]) -> None
+
+
+   .. py:method:: set_transition_for_stage(stage_id: int, transition: Transition)
+
+
+