Metadata-Version: 2.1
Name: jsim-utils
Version: 0.0.24
Summary: Simulation environment for SAR
Home-page: https://jsim.janhendrikewers.uk
Author: iwishiwasaneagle
Author-email: jh.ewers@gmail.com
License: GPL-3.0-or-later
Project-URL: Documentation, https://jsim.janhendrikewers.uk/api/modules.html
Project-URL: Changelog, https://jsim.janhendrikewers.uk/changelog.html
Project-URL: Source, https://github.com/iwishiwasaneagle/jsim
Project-URL: Tracker, https://github.com/iwishiwasaneagle/jsim/issues
Project-URL: Download, https://github.com/iwishiwasaneagle/jsim/releases
Platform: Linux
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
License-File: LICENSE.txt
Requires-Dist: loguru (==0.6.0)
Requires-Dist: matplotlib (==3.5.1)
Requires-Dist: numpy (==1.21.4)
Requires-Dist: rtree (==0.9.7)
Requires-Dist: rasterio (==1.2.10)
Requires-Dist: geopandas (==0.10.2)
Requires-Dist: shapely (==1.8.0)
Requires-Dist: tqdm (==4.62.3)
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: test
Requires-Dist: setuptools ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: tox ; extra == 'test'

[![jSim](https://raw.githubusercontent.com/iwishiwasaneagle/jsim/master/docs/_static/banner.png "jSim")](https://github.com/iwishiwasaneagle/jsim)

[![CI](https://github.com/iwishiwasaneagle/jsim/actions/workflows/CI.yml/badge.svg)](https://github.com/iwishiwasaneagle/jsim/actions/workflows/CI.yml)
[![CD](https://github.com/iwishiwasaneagle/jsim/actions/workflows/CD.yml/badge.svg)](https://github.com/iwishiwasaneagle/jsim/actions/workflows/CD.yml)
[![GitHub](https://img.shields.io/github/license/iwishiwasaneagle/jsim)](https://github.com/iwishiwasaneagle/jsim/blob/master/LICENSE.txt)
[![codecov](https://codecov.io/gh/iwishiwasaneagle/jsim/branch/master/graph/badge.svg?token=0X0UFKI79W)](https://codecov.io/gh/iwishiwasaneagle/jsim)

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

```bash
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][examples] for more insight.

## Docs

Build yourself with `tox -e docs` or visit the [hosted docs][docs]

## Making Changes & Contributing

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

```bash
pip install pre-commit
cd jsim
pre-commit install
```

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

```bash
pre-commit autoupdate
```

## References

- Architecture heavily inspired by [http://incompleteideas.net/RLinterface/RLI-Cplusplus.html](http://incompleteideas.net/RLinterface/RLI-Cplusplus.html)

[docs]: https://http://jsim.janhendrikewers.uk/
[examples]: https://http://jsim.janhendrikewers.uk/examples/


