{"id":24990246,"url":"https://github.com/arup-group/osmox","last_synced_at":"2025-04-12T01:52:02.636Z","repository":{"id":38313118,"uuid":"341249659","full_name":"arup-group/osmox","owner":"arup-group","description":"A tool for extracting facility locations and features from OpenStreetMap (OSM) data","archived":false,"fork":false,"pushed_at":"2025-04-07T16:26:22.000Z","size":15433,"stargazers_count":40,"open_issues_count":12,"forks_count":6,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-12T01:51:53.784Z","etag":null,"topics":["city-modelling-lab","cml","geojson","gis","openstreetmap"],"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/arup-group.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-22T15:40:36.000Z","updated_at":"2025-03-31T16:54:38.000Z","dependencies_parsed_at":"2024-06-03T18:59:05.101Z","dependency_job_id":"6c286365-6222-42b1-b02c-61841caaf72c","html_url":"https://github.com/arup-group/osmox","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arup-group%2Fosmox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arup-group%2Fosmox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arup-group%2Fosmox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arup-group%2Fosmox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arup-group","download_url":"https://codeload.github.com/arup-group/osmox/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505873,"owners_count":21115354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["city-modelling-lab","cml","geojson","gis","openstreetmap"],"created_at":"2025-02-04T13:35:02.648Z","updated_at":"2025-04-12T01:52:02.619Z","avatar_url":"https://github.com/arup-group.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--- the \"--8\u003c--\" html comments define what part of the README to add to the index page of the documentation --\u003e\r\n\u003c!--- --8\u003c-- [start:docs] --\u003e\r\n# OSMOX\r\n\r\nA tool for extracting locations and features from OpenStreetMap (OSM) data.\r\n\r\n## Why?\r\n\r\nWe use OSMOX to extract locations from OSM for city or national scale agent-based models. In particular, the focus tends to be on extracting buildings and their designated usages, for example `homes`, `schools`, `medical facilities` and `places of work`. However, this can also be abstracted to other objects such as transit, parks or land use.\r\n\r\nUnder the hood, OSMOX is a collection of labelling and GIS-type operations:\r\n\r\n- filtering\r\n- activity labelling\r\n- simple spatial activity inference\r\n- feature extraction (such as floor areas)\r\n- filling in missing data\r\n\r\nOnce assembled, these form part of our wider pipeline. But as a standalone tool, OSMOX is useful for extracting insights from OSM in a reproducible manner.\r\n\r\n![isle of man distance_to_nearest_transit](resources/distance-to-transit.png)\r\n*^ Isle of Man `distance_to_nearest_transit`.*\r\n\r\n\u003c!--- --8\u003c-- [end:docs] --\u003e\r\n\r\n## Documentation\r\n\r\nFor more detailed instructions, see our [documentation](https://arup-group.github.io/osmox/latest).\r\n\r\n## Installation\r\n\r\nOSMOX can be installed in Python environments from version 3.10 upwards.\r\n\r\nNote: you can use the instructions [here](#as-a-user-docker-image) to build a Docker image for OSMOX and run it in a container if you cannot install it locally.\r\nThis builds in a Python 3.12 environment.\r\n\r\n### As a user (Docker image)\r\n\r\n```shell\r\ngit clone git@github.com:arup-group/osmox.git\r\ncd osmox\r\ndocker build -t \"osmox\" .\r\n```\r\n\r\n### As a user (Python package)\r\n\r\nTo install osmox, we recommend using the [mamba](https://mamba.readthedocs.io/en/latest/index.html) package manager:\r\n\r\n\u003c!--- --8\u003c-- [start:docs-install-user] --\u003e\r\n``` shell\r\ngit clone git@github.com:arup-group/osmox.git\r\ncd osmox\r\nmamba create -n osmox -c conda-forge -c city-modelling-lab --file requirements/base.txt\r\nmamba activate osmox\r\npip install --no-deps .\r\n```\r\n\u003c!--- --8\u003c-- [end:docs-install-user] --\u003e\r\n\r\n### As a developer\r\n\r\n\u003c!--- --8\u003c-- [start:docs-install-dev] --\u003e\r\n``` shell\r\ngit clone git@github.com:arup-group/osmox.git\r\ncd osmox\r\nmamba create -n osmox -c conda-forge -c city-modelling-lab --file requirements/base.txt --file requirements/dev.txt\r\nmamba activate osmox\r\npip install --no-deps -e .\r\n```\r\n\u003c!--- --8\u003c-- [end:docs-install-dev] --\u003e\r\n\r\nFor more detailed instructions, see our [documentation](https://arup-group.github.io/osmox/latest/installation/).\r\n\r\n## Contributing\r\n\r\nThere are many ways to contribute to osmox.\r\nBefore making contributions to the osmox source code, see our contribution guidelines and follow the [development install instructions](#as-a-developer).\r\n\r\nIf you plan to make changes to the code then please make regular use of the following tools to verify the codebase while you work:\r\n\r\n- `pre-commit`: run `pre-commit install` in your command line to load inbuilt checks that will run every time you commit your changes.\r\nThe checks are: 1. check no large files have been staged, 2. lint python files for major errors, 3. format python files to conform with the [pep8 standard](https://peps.python.org/pep-0008/).\r\nYou can also run these checks yourself at any time to ensure staged changes are clean by simple calling `pre-commit`.\r\n- `pytest` - run the unit test suite and check test coverage.\r\n- `pytest -p memray -m \"high_mem\" --no-cov` (not available on Windows) - after installing memray (`mamba install memray pytest-memray`), test that memory and time performance does not exceed benchmarks.\r\n\r\nFor more information, see our [documentation](https://arup-group.github.io/osmox/latest/contributing/).\r\n\r\n## Building the documentation\r\n\r\nIf you are unable to access the online documentation, you can build the documentation locally.\r\nFirst, [install a development environment of osmox](https://arup-group.github.io/osmox/latest/contributing/coding/), then deploy the documentation using [mike](https://github.com/jimporter/mike):\r\n\r\n```\r\nmike deploy develop\r\nmike serve\r\n```\r\n\r\nThen you can view the documentation in a browser at http://localhost:8000/.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farup-group%2Fosmox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farup-group%2Fosmox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farup-group%2Fosmox/lists"}