flatland-rl


Nameflatland-rl JSON
Version 4.2.1 PyPI version JSON
download
home_pageNone
SummaryMulti Agent Reinforcement Learning on Trains
upload_time2025-09-03 12:54:55
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2019 SBB AG Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords flatland
VCS
bugtrack_url
requirements annotated-types asttokens attrs boto3 botocore certifi charset-normalizer click comm contourpy crowdai-api cycler decorator entrypoint executing fastenum fonttools idna importlib-resources ipycanvas ipyevents ipython ipywidgets jedi jmespath jupyterlab-widgets kiwisolver lxml matplotlib matplotlib-inline msgpack msgpack-numpy named networkx numpy orderings packaging pandas parso pexpect pillow prompt-toolkit ptyprocess pure-eval pydantic pydantic-core pyglet pygments pyparsing python-dateutil python-gitlab pytz pyyaml recordtype redis requests requests-toolbelt s3transfer six solus stack-data svgutils timeout-decorator tqdm traitlets typing-aliases typing-extensions typing-inspection tzdata urllib3 versions wcwidth widgetsnbextension
Travis-CI No Travis.
coveralls test coverage No coveralls.
            🚂 Flatland
========

![Flatland](https://i.imgur.com/0rnbSLY.gif)

[![Main](https://github.com/flatland-association/flatland-rl/actions/workflows/main.yml/badge.svg)](https://github.com/flatland-association/flatland-rl/actions/workflows/main.yml)

Flatland is an open-source toolkit for developing and comparing Multi-Agent Reinforcement Learning algorithms in little
(or ridiculously large!) gridworlds.

[The official documentation](https://flatland-association.github.io/flatland-book/intro.html) contains full details about the environment and problem
statement.

Flatland is tested with Python 3.10, 3.11, 3.12 and 3.13 on modern versions of macOS, Linux and Windows. You may encounter
problems with graphical rendering if you use WSL.

🏆 Challenges
---

This library was developed specifically for the
AIcrowd [Flatland challenges](http://flatland.aicrowd.com/research/top-challenge-solutions.html) in which we strongly
encourage you to take part in!

- [Flatland 3 Challenge](https://www.aicrowd.com/challenges/flatland-3)
- [AMLD 2021 Challenge](https://www.aicrowd.com/challenges/flatland)
- [NeurIPS 2020 Challenge](https://www.aicrowd.com/challenges/neurips-2020-flatland-challenge/)
- [2019 Challenge](https://www.aicrowd.com/challenges/flatland-challenge)

📦 Setup
---

### Setup virtual environment

Set up a virtual environment using your preferred method (we suggest the built-in `venv`) and activate it.
You can use your IDE to do this or by using the command line:

```shell
python -m venv .venv
source .venv/bin/activate
```

### Stable release

Install Flatland using pip:

```shell
python -m pip install flatland-rl
```

This is the preferred method to install Flatland, as it will always install the most recent stable release.

👥 Credits
---

This library was initially developed
by [SBB](https://www.sbb.ch/en/), [Deutsche Bahn](https://www.deutschebahn.com/), [SNCF](https://www.sncf.com/en),
[AIcrowd](https://www.aicrowd.com/) and [numerous contributors](https://flatland-association.github.io/flatland-book/misc/credits.html) from the
flatland community. It is now developed by the [Flatland Association](https://flatland-association.org) and the [Flatland Community](https://flatland.cloud).

➕ Contributions
---
Please follow the [Contribution Guidelines](./CONTRIBUTING.md) for more details on how you can successfully contribute
to the project. We enthusiastically look forward to your contributions!

💬 Communication
---

* [Issue Tracker](https://github.com/flatland-association/flatland-rl/issues/)

🔗 Partners
---
<a href="https://sbb.ch" target="_blank" style="margin-right:30px"><img src="https://flatland-association.org/members/sbb-cff-ffs-logo.svg" alt="SBB" height="60"/></a>
&nbsp;
<a href="https://www.deutschebahn.com/" target="_blank" style="margin-right:30px"><img src="https://i.imgur.com/pjTki15.png" alt="DB"  height="60"/></a>
&nbsp;
<a href="https://www.sncf.com/en" target="_blank" style="margin-right:30px"><img src="https://iconape.com/wp-content/png_logo_vector/logo-sncf.png" alt="SNCF"  height="60"/></a>
&nbsp;
<a href="https://www.aicrowd.com" target="_blank"><img src="https://i.imgur.com/kBZQGI9.png" alt="AIcrowd"  height="60"/></a>
&nbsp;
<a href="https://flatland.cloud" target="_blank"><img src="https://flatland-association.org/members/flatland-community-logo.svg" alt="Flatland Community"  height="60"/></a>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "flatland-rl",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "flatland",
    "author": null,
    "author_email": "Flatland Association <contact@flatland-association.org>",
    "download_url": "https://files.pythonhosted.org/packages/1c/e5/85d232d0ce66ebe5a814372e5008c8dab86c0e9c62456635a9c0cc1b2d69/flatland_rl-4.2.1.tar.gz",
    "platform": null,
    "description": "\ud83d\ude82 Flatland\n========\n\n![Flatland](https://i.imgur.com/0rnbSLY.gif)\n\n[![Main](https://github.com/flatland-association/flatland-rl/actions/workflows/main.yml/badge.svg)](https://github.com/flatland-association/flatland-rl/actions/workflows/main.yml)\n\nFlatland is an open-source toolkit for developing and comparing Multi-Agent Reinforcement Learning algorithms in little\n(or ridiculously large!) gridworlds.\n\n[The official documentation](https://flatland-association.github.io/flatland-book/intro.html) contains full details about the environment and problem\nstatement.\n\nFlatland is tested with Python 3.10, 3.11, 3.12 and 3.13 on modern versions of macOS, Linux and Windows. You may encounter\nproblems with graphical rendering if you use WSL.\n\n\ud83c\udfc6 Challenges\n---\n\nThis library was developed specifically for the\nAIcrowd [Flatland challenges](http://flatland.aicrowd.com/research/top-challenge-solutions.html) in which we strongly\nencourage you to take part in!\n\n- [Flatland 3 Challenge](https://www.aicrowd.com/challenges/flatland-3)\n- [AMLD 2021 Challenge](https://www.aicrowd.com/challenges/flatland)\n- [NeurIPS 2020 Challenge](https://www.aicrowd.com/challenges/neurips-2020-flatland-challenge/)\n- [2019 Challenge](https://www.aicrowd.com/challenges/flatland-challenge)\n\n\ud83d\udce6 Setup\n---\n\n### Setup virtual environment\n\nSet up a virtual environment using your preferred method (we suggest the built-in `venv`) and activate it.\nYou can use your IDE to do this or by using the command line:\n\n```shell\npython -m venv .venv\nsource .venv/bin/activate\n```\n\n### Stable release\n\nInstall Flatland using pip:\n\n```shell\npython -m pip install flatland-rl\n```\n\nThis is the preferred method to install Flatland, as it will always install the most recent stable release.\n\n\ud83d\udc65 Credits\n---\n\nThis library was initially developed\nby [SBB](https://www.sbb.ch/en/), [Deutsche Bahn](https://www.deutschebahn.com/), [SNCF](https://www.sncf.com/en),\n[AIcrowd](https://www.aicrowd.com/) and [numerous contributors](https://flatland-association.github.io/flatland-book/misc/credits.html) from the\nflatland community. It is now developed by the [Flatland Association](https://flatland-association.org) and the [Flatland Community](https://flatland.cloud).\n\n\u2795 Contributions\n---\nPlease follow the [Contribution Guidelines](./CONTRIBUTING.md) for more details on how you can successfully contribute\nto the project. We enthusiastically look forward to your contributions!\n\n\ud83d\udcac Communication\n---\n\n* [Issue Tracker](https://github.com/flatland-association/flatland-rl/issues/)\n\n\ud83d\udd17 Partners\n---\n<a href=\"https://sbb.ch\" target=\"_blank\" style=\"margin-right:30px\"><img src=\"https://flatland-association.org/members/sbb-cff-ffs-logo.svg\" alt=\"SBB\" height=\"60\"/></a>\n&nbsp;\n<a href=\"https://www.deutschebahn.com/\" target=\"_blank\" style=\"margin-right:30px\"><img src=\"https://i.imgur.com/pjTki15.png\" alt=\"DB\"  height=\"60\"/></a>\n&nbsp;\n<a href=\"https://www.sncf.com/en\" target=\"_blank\" style=\"margin-right:30px\"><img src=\"https://iconape.com/wp-content/png_logo_vector/logo-sncf.png\" alt=\"SNCF\"  height=\"60\"/></a>\n&nbsp;\n<a href=\"https://www.aicrowd.com\" target=\"_blank\"><img src=\"https://i.imgur.com/kBZQGI9.png\" alt=\"AIcrowd\"  height=\"60\"/></a>\n&nbsp;\n<a href=\"https://flatland.cloud\" target=\"_blank\"><img src=\"https://flatland-association.org/members/flatland-community-logo.svg\" alt=\"Flatland Community\"  height=\"60\"/></a>\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2019 SBB AG\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "Multi Agent Reinforcement Learning on Trains",
    "version": "4.2.1",
    "project_urls": {
        "Github Repository": "https://github.com/flatland-association/flatland-rl",
        "Homepage": "https://www.flatland-association.org",
        "Issue Tracker": "https://github.com/flatland-association/flatland-rl/issues"
    },
    "split_keywords": [
        "flatland"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bedace7b2638b94504728aa5733752e50e6df685b161ae458c08b43d9958fed1",
                "md5": "de523a32bcd6a75aef823051c19ec56c",
                "sha256": "2299c6af565be670455cb2f98f0374bfc5f68e5aa80e4568a27e756a47ab441f"
            },
            "downloads": -1,
            "filename": "flatland_rl-4.2.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "de523a32bcd6a75aef823051c19ec56c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.10",
            "size": 20523499,
            "upload_time": "2025-09-03T12:54:53",
            "upload_time_iso_8601": "2025-09-03T12:54:53.040053Z",
            "url": "https://files.pythonhosted.org/packages/be/da/ce7b2638b94504728aa5733752e50e6df685b161ae458c08b43d9958fed1/flatland_rl-4.2.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1ce585d232d0ce66ebe5a814372e5008c8dab86c0e9c62456635a9c0cc1b2d69",
                "md5": "ff713463395343478fb2456131a89379",
                "sha256": "6f1bc45d20ae7ecbb29e15dac9ca3d46bcc6026060eebd2b94283d632ac4c330"
            },
            "downloads": -1,
            "filename": "flatland_rl-4.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ff713463395343478fb2456131a89379",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 20321115,
            "upload_time": "2025-09-03T12:54:55",
            "upload_time_iso_8601": "2025-09-03T12:54:55.568833Z",
            "url": "https://files.pythonhosted.org/packages/1c/e5/85d232d0ce66ebe5a814372e5008c8dab86c0e9c62456635a9c0cc1b2d69/flatland_rl-4.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-03 12:54:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "flatland-association",
    "github_project": "flatland-rl",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "annotated-types",
            "specs": [
                [
                    "==",
                    "0.7.0"
                ]
            ]
        },
        {
            "name": "asttokens",
            "specs": [
                [
                    "==",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "attrs",
            "specs": [
                [
                    "==",
                    "25.3.0"
                ]
            ]
        },
        {
            "name": "boto3",
            "specs": [
                [
                    "==",
                    "1.40.12"
                ]
            ]
        },
        {
            "name": "botocore",
            "specs": [
                [
                    "==",
                    "1.40.12"
                ]
            ]
        },
        {
            "name": "certifi",
            "specs": [
                [
                    "==",
                    "2025.8.3"
                ]
            ]
        },
        {
            "name": "charset-normalizer",
            "specs": [
                [
                    "==",
                    "3.4.3"
                ]
            ]
        },
        {
            "name": "click",
            "specs": [
                [
                    "==",
                    "8.2.1"
                ]
            ]
        },
        {
            "name": "comm",
            "specs": [
                [
                    "==",
                    "0.2.3"
                ]
            ]
        },
        {
            "name": "contourpy",
            "specs": [
                [
                    "==",
                    "1.3.2"
                ]
            ]
        },
        {
            "name": "crowdai-api",
            "specs": [
                [
                    "==",
                    "0.1.22"
                ]
            ]
        },
        {
            "name": "cycler",
            "specs": [
                [
                    "==",
                    "0.12.1"
                ]
            ]
        },
        {
            "name": "decorator",
            "specs": [
                [
                    "==",
                    "5.2.1"
                ]
            ]
        },
        {
            "name": "entrypoint",
            "specs": [
                [
                    "==",
                    "2.1.0"
                ]
            ]
        },
        {
            "name": "executing",
            "specs": [
                [
                    "==",
                    "2.2.0"
                ]
            ]
        },
        {
            "name": "fastenum",
            "specs": [
                [
                    "==",
                    "1.1.2"
                ]
            ]
        },
        {
            "name": "fonttools",
            "specs": [
                [
                    "==",
                    "4.59.1"
                ]
            ]
        },
        {
            "name": "idna",
            "specs": [
                [
                    "==",
                    "3.10"
                ]
            ]
        },
        {
            "name": "importlib-resources",
            "specs": [
                [
                    "==",
                    "6.5.2"
                ]
            ]
        },
        {
            "name": "ipycanvas",
            "specs": [
                [
                    "==",
                    "0.14.1"
                ]
            ]
        },
        {
            "name": "ipyevents",
            "specs": [
                [
                    "==",
                    "2.0.2"
                ]
            ]
        },
        {
            "name": "ipython",
            "specs": [
                [
                    "==",
                    "8.37.0"
                ]
            ]
        },
        {
            "name": "ipywidgets",
            "specs": [
                [
                    "==",
                    "8.1.7"
                ]
            ]
        },
        {
            "name": "jedi",
            "specs": [
                [
                    "==",
                    "0.19.2"
                ]
            ]
        },
        {
            "name": "jmespath",
            "specs": [
                [
                    "==",
                    "1.0.1"
                ]
            ]
        },
        {
            "name": "jupyterlab-widgets",
            "specs": [
                [
                    "==",
                    "3.0.15"
                ]
            ]
        },
        {
            "name": "kiwisolver",
            "specs": [
                [
                    "==",
                    "1.4.9"
                ]
            ]
        },
        {
            "name": "lxml",
            "specs": [
                [
                    "==",
                    "6.0.0"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    "==",
                    "3.10.5"
                ]
            ]
        },
        {
            "name": "matplotlib-inline",
            "specs": [
                [
                    "==",
                    "0.1.7"
                ]
            ]
        },
        {
            "name": "msgpack",
            "specs": [
                [
                    "==",
                    "1.1.1"
                ]
            ]
        },
        {
            "name": "msgpack-numpy",
            "specs": [
                [
                    "==",
                    "0.4.8"
                ]
            ]
        },
        {
            "name": "named",
            "specs": [
                [
                    "==",
                    "1.4.2"
                ]
            ]
        },
        {
            "name": "networkx",
            "specs": [
                [
                    "==",
                    "3.4.2"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "==",
                    "1.26.4"
                ]
            ]
        },
        {
            "name": "orderings",
            "specs": [
                [
                    "==",
                    "1.6.0"
                ]
            ]
        },
        {
            "name": "packaging",
            "specs": [
                [
                    "==",
                    "25.0"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    "==",
                    "2.3.1"
                ]
            ]
        },
        {
            "name": "parso",
            "specs": [
                [
                    "==",
                    "0.8.4"
                ]
            ]
        },
        {
            "name": "pexpect",
            "specs": [
                [
                    "==",
                    "4.9.0"
                ]
            ]
        },
        {
            "name": "pillow",
            "specs": [
                [
                    "==",
                    "11.3.0"
                ]
            ]
        },
        {
            "name": "prompt-toolkit",
            "specs": [
                [
                    "==",
                    "3.0.51"
                ]
            ]
        },
        {
            "name": "ptyprocess",
            "specs": [
                [
                    "==",
                    "0.7.0"
                ]
            ]
        },
        {
            "name": "pure-eval",
            "specs": [
                [
                    "==",
                    "0.2.3"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    "==",
                    "2.11.7"
                ]
            ]
        },
        {
            "name": "pydantic-core",
            "specs": [
                [
                    "==",
                    "2.33.2"
                ]
            ]
        },
        {
            "name": "pyglet",
            "specs": [
                [
                    "==",
                    "2.1.8"
                ]
            ]
        },
        {
            "name": "pygments",
            "specs": [
                [
                    "==",
                    "2.19.2"
                ]
            ]
        },
        {
            "name": "pyparsing",
            "specs": [
                [
                    "==",
                    "3.2.3"
                ]
            ]
        },
        {
            "name": "python-dateutil",
            "specs": [
                [
                    "==",
                    "2.9.0.post0"
                ]
            ]
        },
        {
            "name": "python-gitlab",
            "specs": [
                [
                    "==",
                    "6.2.0"
                ]
            ]
        },
        {
            "name": "pytz",
            "specs": [
                [
                    "==",
                    "2025.2"
                ]
            ]
        },
        {
            "name": "pyyaml",
            "specs": [
                [
                    "==",
                    "6.0.2"
                ]
            ]
        },
        {
            "name": "recordtype",
            "specs": [
                [
                    "==",
                    "1.4"
                ]
            ]
        },
        {
            "name": "redis",
            "specs": [
                [
                    "==",
                    "6.4.0"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.32.5"
                ]
            ]
        },
        {
            "name": "requests-toolbelt",
            "specs": [
                [
                    "==",
                    "1.0.0"
                ]
            ]
        },
        {
            "name": "s3transfer",
            "specs": [
                [
                    "==",
                    "0.13.1"
                ]
            ]
        },
        {
            "name": "six",
            "specs": [
                [
                    "==",
                    "1.17.0"
                ]
            ]
        },
        {
            "name": "solus",
            "specs": [
                [
                    "==",
                    "1.2.2"
                ]
            ]
        },
        {
            "name": "stack-data",
            "specs": [
                [
                    "==",
                    "0.6.3"
                ]
            ]
        },
        {
            "name": "svgutils",
            "specs": [
                [
                    "==",
                    "0.3.4"
                ]
            ]
        },
        {
            "name": "timeout-decorator",
            "specs": [
                [
                    "==",
                    "0.5.0"
                ]
            ]
        },
        {
            "name": "tqdm",
            "specs": [
                [
                    "==",
                    "4.67.1"
                ]
            ]
        },
        {
            "name": "traitlets",
            "specs": [
                [
                    "==",
                    "5.14.3"
                ]
            ]
        },
        {
            "name": "typing-aliases",
            "specs": [
                [
                    "==",
                    "1.10.1"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "==",
                    "4.14.1"
                ]
            ]
        },
        {
            "name": "typing-inspection",
            "specs": [
                [
                    "==",
                    "0.4.1"
                ]
            ]
        },
        {
            "name": "tzdata",
            "specs": [
                [
                    "==",
                    "2025.2"
                ]
            ]
        },
        {
            "name": "urllib3",
            "specs": [
                [
                    "==",
                    "2.5.0"
                ]
            ]
        },
        {
            "name": "versions",
            "specs": [
                [
                    "==",
                    "1.6.1"
                ]
            ]
        },
        {
            "name": "wcwidth",
            "specs": [
                [
                    "==",
                    "0.2.13"
                ]
            ]
        },
        {
            "name": "widgetsnbextension",
            "specs": [
                [
                    "==",
                    "4.0.14"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "flatland-rl"
}
        
Elapsed time: 2.69533s