https://github.com/arup-group/genet
Manipulate MATSim networks via a Python API.
https://github.com/arup-group/genet
arup city-modelling city-modelling-lab cml network
Last synced: 6 months ago
JSON representation
Manipulate MATSim networks via a Python API.
- Host: GitHub
- URL: https://github.com/arup-group/genet
- Owner: arup-group
- License: mit
- Created: 2020-05-19T13:35:22.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T18:58:13.000Z (6 months ago)
- Last Synced: 2025-04-12T01:51:48.690Z (6 months ago)
- Topics: arup, city-modelling, city-modelling-lab, cml, network
- Language: Python
- Homepage:
- Size: 58.7 MB
- Stars: 47
- Watchers: 8
- Forks: 10
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Network Scenario Generator (GeNet)
[](https://zenodo.org/badge/latestdoi/265256468)
GeNet provides tools to represent and work with a multi-modal transport network with public transport (PT)
services. It is based on [MATSim's](https://www.matsim.org/) representation of such networks.
The goal of GeNet is to:
- Provide a formalised in-memory data structure for representing a multi-modal network with a PT service
- Enable using the data structure for tasks such as generating auxiliary MATSim files e.g. Road Pricing
- Simplify the process of modifying a network and provide a simple change log to track the differences between the input
and output networks.
- Provide validation methods to check for simple errors such as: whether a `Route` has more than one `Stop` or that the
underlying graph doesn't have any dead-ends or sources (a place which you can leave but cannot get back to).
The underlying
network available to PT services (roads, railways, but also ferry/flight connections) uses a `networkx.MultiDiGraph`
with additional methods for `'links'` which are unique in `genet.Network` (`networkx.MultiDiGraph` accepts multiple
edges between the same from and to node pair; referring to an edge in `networkx.MultiDiGraph` and `genet.Network`
has the same effects, i.e. the result is a dictionary indexed by the multi edge index). The PT services are
represented through the `genet.Schedule` class which relies on other `genet`
classes: the `Schedule` relies on a list of `genet.Service`'s, which in turn consists of a list of `genet.Route`'s.
Each `Route` class object has an attribute `stops` which consists of `genet.Stops` objects. The `Stops` carry spatial
information for the PT stop.
You can use GeNet's CLI to run pre-baked modifications or checks on networks.
You can also write your own python scripts, importing genet as a package, use IPython shell or Jupyter Notebook to load up a network, inspect or change it and save it out to file.
## Documentation
For more detailed instructions, see our [documentation](https://arup-group.github.io/genet/latest).
## Installation
If you do not plan to make any code changes, you can install GeNet as a [Docker image](#as-a-docker-image) or a [Python package](#as-a-python-package).
For more detailed instructions, see our [documentation](https://arup-group.github.io/genet/latest/installation/).
### As a Docker image
```shell
git clone git@github.com:arup-group/genet.git
cd genet
docker build -t "cml-genet" .
```
### As a Python package
To install genet (indexed online as cml-genet), we recommend using the [mamba](https://mamba.readthedocs.io/en/latest/index.html) package manager:
``` shell
git clone git@github.com:arup-group/genet.git
cd genet
mamba create -n genet -c conda-forge -c city-modelling-lab --file requirements/base.txt
mamba activate genet
pip install --no-deps .
```
## Contributing
There are many ways to contribute to genet.
Before making contributions to the genet source code, see our contribution guidelines and follow the [development install instructions](#installing-a-development-environment).
If you plan to make changes to the code then please make regular use of the following tools to verify the codebase while you work:
- `pre-commit`: run `pre-commit install` in your command line to load inbuilt checks that will run every time you commit your changes.
The 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/).
You can also run these checks yourself at any time to ensure staged changes are clean by simple calling `pre-commit`.
- `pytest` - run the unit test suite and check test coverage.
For more information, see our [documentation](https://arup-group.github.io/genet/latest/contributing/).
### Installing a development environment
``` shell
git clone git@github.com:arup-group/genet.git
cd genet
mamba create -n genet -c conda-forge -c city-modelling-lab --file requirements/base.txt --file requirements/dev.txt
mamba activate genet
pip install --no-deps -e .
ipython kernel install --user --name=genet
```
## Building the documentation
If you are unable to access the online documentation, you can build the documentation locally.
First, [install a development environment of genet](#installing-a-development-environment), then deploy the documentation using [mike](https://github.com/jimporter/mike):
```
mike deploy develop
mike serve
```
Then you can view the documentation in a browser at http://localhost:8000/.
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [arup-group/cookiecutter-pypackage](https://github.com/arup-group/cookiecutter-pypackage) project template.