zele-utils/README.md

24 lines
774 B
Markdown
Raw Normal View History

2024-09-07 18:13:36 -04:00
# Zele-Utils
A CLI tool for preprocessing and pushing data to the database for the Zele project.
## Installation
1. Install Anaconda or Miniconda.
2. Create the environment and install required packages:
```bash
conda env create -f environment.yml
```
3. Activate the environment:
```bash
conda activate zele-utils
```
4. Set up your `.env` file using `.example.env` as a template.
## Usage
Place the file you want to process in `/data/` and push to the database in the appropriate directory. Run the corresponding command. For a list of available commands and options, use:
```bash
python main.py --help
```
## Features
1. Processes MATSim's `Population.xml` and `Network.xml` files.
2. Processes data from the Overpass API and `map.osm` file.