Metadata-Version: 2.1
Name: gridsim
Version: 0.1.2
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/markdown
Requires-Dist: pygame
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: pyyaml

# Gridsim

[![Build Status](https://travis-ci.com/jtebert/gridsim.svg?branch=master)](https://travis-ci.com/jtebert/gridsim)
[![Documentation Status](https://readthedocs.org/projects/pip/badge/?version=stable)](http://pip.pypa.io/en/stable/?badge=stable)
[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/jtebert/gridsim?include_prereleases&sort=semver)](https://github.com/jtebert/gridsim/releases)


*Simple grid-based robot simulator*

**[Documentation](https://gridsim.readthedocs.io/)**

I'm planning on using this as a simple test-bed for my algorithms.

This package will be a package/library for the simulator itself, not the robot code. This follows a similar structure (with a World, Robot, Logger, and Viewer) as Kilosim.

I plan to package this with PyPi so I can easily use it with separate repositories for the algorithms.

For reference on package structure, see the [package-boilerplate](https://github.com/jtebert/package-boilerplate).

## Development

### Build Documentation

from the `docs` directory, run:

```shell
make html
```

Then open the documentation:

```shell
open _build/html/index.html
```

### Build the distributable for PyPi

(From the [PyPi tutorial](https://packaging.python.org/tutorials/packaging-projects/))

Make sure the necessary dependencies are installed.

```shell
pip3 install --upgrade setuptools wheel twine
```

Build the project. From the project root folder, run:

```shell
python3 setup.py sdist bdist_wheel
```

Upload it to the testing index:

```shell
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

Upload it to the actual index:

```shell
python3 -m twine upload dist/*
```

