Metadata-Version: 2.1
Name: gridsim
Version: 0.4
Summary: Simple grid-based robot simulator
Home-page: https://gridsim.readthedocs.io
Author: Julia Ebert
Author-email: julia@juliaebert.com
License: UNKNOWN
Download-URL: https://github.com/jtebert/gridsim
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Robot Framework
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: pygame
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: pyyaml
Requires-Dist: pillow

Gridsim
=======

.. image:: https://travis-ci.com/jtebert/gridsim.svg?branch=master
  :target: https://travis-ci.com/jtebert/gridsim
  :alt: Build Status

.. image:: https://readthedocs.org/projects/gridsim/badge/?version=latest
  :target: https://gridsim.readthedocs.io/en/latest/?badge=latest
  :alt: Documentation Status

.. image:: https://img.shields.io/github/v/release/jtebert/gridsim?include_prereleases&sort=semver
  :target: https://github.com/jtebert/gridsim/releases
  :alt: Latest GitHub Release (including pre-releases)

.. .. include:: docs/description.rst

Gridsim is a Python 3 library for simulating robots in a grid-based world. It has a simple, well-documented API, making it easy to implement your own algorithms with minimal overhead.

Key features include:

- Viewer for debugging and visualizing your simulations
- Built-in data logging to HDF5 files
- Support for YAML configuration files
- Extendable robot classes to avoid repeating your code
- Comprehensive documentation and examples

Quick Install
-------------

.. code-block:: console

    $ pip install gridsim

For more information and instructions, check out the `documentation <https://gridsim.readthedocs.io/en/latest/>`_.

Links
-----

**Documentation:** `Read the Docs <https://gridsim.readthedocs.io/en/latest/>`_

**PyPi:** `gridsim <https://pypi.org/project/gridsim/>`_

Contact
-------

If you have questions, or if you've done something interesting with this package, send me an email: `julia@juliaebert.com <mailto:julia@juliaebert.com>`_.

If you find a problem or want something added to the library, `open an issue on Github <https://github.com/jtebert/gridsim/issues>`_.


