Skip to content
Snippets Groups Projects
Commit e71f0572 authored by mohanty's avatar mohanty
Browse files

Merge branch 'master' into 'master'

Master

See merge request !12
parents 0ad69215 1edaf004
No related branches found
No related tags found
1 merge request!12Master
Pipeline #428 failed
======== ========
flatland Flatland
======== ========
...@@ -15,37 +15,76 @@ flatland ...@@ -15,37 +15,76 @@ flatland
Multi Agent Reinforcement Learning on Trains Multi Agent Reinforcement Learning on Trains
Getting Started
===============
Generate Docs Generate Docs
-------------- --------------
| The docs have a lot more details about how to interact with this codebase.
| **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here.
.. code-block:: bash
git clone git@gitlab.aicrowd.com:flatland/flatland.git The docs have a lot more details about how to interact with this codebase.
cd flatland
pip install -r requirements_dev.txt
* Linux and macOS **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here ::
.. code-block:: bash git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland
pip install -r requirements_dev.txt
make docs * On, Linux and macOS ::
make docs
* Windows
.. code-block:: bash * On, Windows ::
python setup.py develop (or) python setup.py develop (or)
python setup.py install python setup.py install
python make_docs.py python make_docs.py
Features Features
-------- --------
* TODO TODO
Installation
============
Stable Release
--------------
To install flatland, run this command in your terminal ::
pip install flatland-rl
This is the preferred method to install flatland, as it will always install the most recent stable release.
If you don’t have `pip <https://pip.pypa.io/en/stable/>`_ installed, this `Python installation guide <https://docs.python-guide.org/starting/installation/>`_ can guide you through the process.
From Sources
------------
The sources for flatland can be downloaded from the `Gitlab repo <https://gitlab.aicrowd.com/flatland/flatland>`_.
You can clone the public repository ::
$ git clone git@gitlab.aicrowd.com:flatland/flatland.git
Once you have a copy of the source, you can install it with ::
$ python setup.py install
Usage
=====
To use flatland in a project ::
import flatland
flatland
========
TODO: explain the interface here
Authors Authors
-------- --------
...@@ -55,5 +94,7 @@ Authors ...@@ -55,5 +94,7 @@ Authors
* Jeremy Watson * Jeremy Watson
* Erik Nygren <erik.nygren@sbb.ch> * Erik Nygren <erik.nygren@sbb.ch>
* Adrian Egli <adrian.egli@sbb.ch> * Adrian Egli <adrian.egli@sbb.ch>
* Vaibhav Agrawal <theinfamouswayne@gmail.com>
<please fill yourself in> <please fill yourself in>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment