{"id":28428180,"url":"https://github.com/saruccio/flatland","last_synced_at":"2026-05-01T02:33:08.009Z","repository":{"id":40973686,"uuid":"225229126","full_name":"Saruccio/Flatland","owner":"Saruccio","description":"Virtual 2-D environment","archived":false,"fork":false,"pushed_at":"2022-12-08T03:21:34.000Z","size":365,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-01T02:32:57.344Z","etag":null,"topics":["mapping","robotics","simulator"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Saruccio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-01T20:51:55.000Z","updated_at":"2020-08-25T20:52:11.000Z","dependencies_parsed_at":"2023-01-24T07:30:36.710Z","dependency_job_id":null,"html_url":"https://github.com/Saruccio/Flatland","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Saruccio/Flatland","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saruccio%2FFlatland","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saruccio%2FFlatland/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saruccio%2FFlatland/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saruccio%2FFlatland/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Saruccio","download_url":"https://codeload.github.com/Saruccio/Flatland/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saruccio%2FFlatland/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32483406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mapping","robotics","simulator"],"created_at":"2025-06-05T12:37:36.647Z","updated_at":"2026-05-01T02:33:07.972Z","avatar_url":"https://github.com/Saruccio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flatland\n\nFlatland is a library that allows you to create a virtual 2-D environment in\nwhich you can put and move one or more virtual sensors to get virtual range\nmeasures.\n\nMoving the sensors into this virtual space (really a plan) you can study how \nto implement your \n[SLAM](https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping) \nor navigation algorithms.\n\nThe name Flatland is after the romance\n[\"Flatland: A Romance of Many Dimensions\"](https://en.wikipedia.org/wiki/Flatland)\nby  Edwin Abbott Abbott.\n\nThis romance describes a flat world populated by geometric figures that live\nand act as persons.\n\n## Install\n\n### 0. Install Python and Git\n\nIn order to use Flatland package and read its complete documentation you must first install Python and Git application on your operating system.\n\n#### Python 3.x installation\n\nThe Flatland package requires a Python version \u003e= 3.5\n\n**Linux** users can install Python directly from their distribution packages.\n\n**Windows** users can download and install Python 3.x from [official site](https://www.python.org/downloads/windows/)\n\n#### Git installation\n\n**Windows** users can follow the instruction on the [official site](https://gitforwindows.org/) \n\n**Linux Debian flavored** users can run `apt-get install git`\n\n**Linux other flavours** users can install it from their package manager.\n\n\n### 1. Create a dedicated virtual environment\n\n```python\n  python3 -m venv flatland\n```\n\n\n\n### 2. Move into the virtual environment and clone this repository\n\nTo clone a git repository you have first to move into the flatland directory and type the commands\n\n```\n  cd flatland\n  git clone https://github.com/Saruccio/Flatland.git\n```\n\nThis will end up in a Flatland folder to appear in your virtual environment directory.\n\n### 3. Install prerequisite using *pip*\n\n#### 3.1 Activate flatland virtualenv\nMove into the virtual environment and activate it\n\n**Windows**\n\n```\n  cd flatland\n  Script\\activate\n```\n\n**Linux**\n```\n  cd flatland\n  source bin/activate\n```\n\nthis will ensure that all packages will be installed into the virtual environment without polluting the global (or external) Python runtime environment.\n\n#### 3.2 Install prerequisite\n\nAll prerequisite have been listed into the file *requirements.txt* lying into the Flatland directory.\n  To install them type\n  \n```\n   cd flatland\n   pip install -r Flatland/requirements.txt\n```\n \n### 4. Build the documentation\n\nThe documentation is written using the [Sphinx](http://www.sphinx-doc.org/en/master/) and you can build the last release in html format issuing following commands\n\n```\ncd Flatland\\docs \nmake html\n```\n\nWhen build completes you can read the documentation loading the file `Flatland/docs/build/html/index.html` in a browser.\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaruccio%2Fflatland","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaruccio%2Fflatland","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaruccio%2Fflatland/lists"}