Skip to content

iwishiwasaneagle/jsim

Repository files navigation

jSim

CI CD GitHub codecov

SAR is a unique design problem for path planning with little exposure to research. The search planning is highly dependent on the environment, and what it contains. Many papers use Probability Distribution Maps (PDMs) to inform the algorithms to make better paths since less time taken to find a missing person means higher chance of survivability.

This simulation environment is built to accommodate my research into this topic but anyone interested is more than welcome to help me build it.

Installation

pip install jsim-utils

Usage

Agent, Simulation, and Environment are designed to be used as base classes. The developer must extend them as required. Have a look at the examples for more insight.

Docs

Build yourself with tox -e docs or visit the hosted docs

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd jsim
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

References