update readme

CITATION.cff

@@ -1,20 +1,20 @@
 cff-version: 1.2.0
-title: MATSim Scenario Template (Adjust title)
+title: MATSim Open Mexico-City Scenario
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
 type: software
 authors:
+   - given-names: Simon
+     family-names: Meinhardt
+     email: [email protected]
+     affiliation: Technische Universität Berlin
+     orcid: 'https://orcid.org/0000-0002-6354-4529'
   - given-names: Christian
     family-names: Rakow
     email: [email protected]
     affiliation: Technische Universität Berlin
     orcid: 'https://orcid.org/0000-0002-6354-4529'
-  - given-names: Simon
-      family-names: Meinhardt
-      email: [email protected]
-      affiliation: Technische Universität Berlin
-      orcid: 'https://orcid.org/0000-0002-6354-4529'
 
 url: "https://github.com/matsim-scenarios/matsim-mexico-city"
 TODO: adapt release date

README.md

@@ -1,50 +1,29 @@
 # The MATSim Open Mexico City Scenario
 
-![Build Status](https://github.com/matsim-scenarios/matsim-mexico-city/workflows/build/badge.svg?branch=main)
-[comment]: <> (TODO: do I have to create this .svg file? -> ask CR)
+[![Build Status](https://github.com/matsim-scenarios/matsim-mexico-city/actions/workflows/build.yaml/badge.svg)](https://github.com/matsim-scenarios/matsim-mexico-city/actions/workflows/build.yaml)
 ![license](https://img.shields.io/github/license/matsim-scenarios/matsim-mexico-city.svg)
 ![JDK](https://img.shields.io/badge/JDK-17+-green.svg)
 
 
-[comment]: <> (TODO: create this png)
-![MATSim network and agents](scenarios/visualization.png "MATSim network and agents")
-
-
-----
-
-When using this template make sure to adapt it as needed:
-
-- [x] Rename Run-Class in `src/main/java` folder
-- [x] Modify config in `input`
-- [x] Update pom.xml
-  - [x] Name, description and version
-  - [x] Main class
-- [ ] Makefile
-- [x] Update CITATION.cff (Authors and version)
-- [x] Modify calibration.py in `src/main/python`
-- [ ] Update README.md (This file)
-  - [x] Change Name and URLs
-  - [x] Badges
-  - [ ] Remove this TODO list when done
-
-----
+[comment]: <>
+![MATSim network and agents](visualization_mexico-city.png "MATSim network and agents")
 
 ### About this project
 
-This repository provides an open MATSim transport model for Mexico City, provided by the [Transport Systems Planning and Transport Telematics group](https://www.vsp.tu-berlin.de) of [Technische Universität Berlin](http://www.tu-berlin.de).
+This repository provides an open MATSim transport model for Mexico City, provided by the [Transport Systems Planning and Transport Telematics group](https://www.tu.berlin/vsp) of [Technische Universität Berlin](https://www.tu.berlin/).
 
-<a rel="TU Berlin" href="https://www.vsp.tu-berlin.de"><img src="https://svn.vsp.tu-berlin.de/repos/public-svn/ueber_uns/logo/TUB_Logo.png" width="15%" height="15%"/></a>
+<a rel="TU Berlin" href="https://www.vsp.tu-berlin.de"><img src="https://svn.vsp.tu-berlin.de/repos/public-svn/ueber_uns/logo/TU_BERLIN_Logo_Lang_RGB_SR_rot.svg" width="25%"/></a>
 
-This scenario contains a 1pct sample of Mexico City and its surrounding area; road capacities are accordingly reduced. The scenario is calibrated taking into consideration the traffic counts, modal split and mode-specific trip distance distributions.
+This scenario contains a 1pct sample of Mexico City (CDMX) and its surrounding metropolitan area (ZMVM); road capacities are reduced accordingly. The scenario is calibrated taking into consideration the traffic counts and modal split for Mexico City.
 
 ### Licenses
 
-The **MATSim program code** in this repository is distributed under the terms of the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html.en). The MATSim program code are files that reside in the `src` directory hierarchy and typically end with `*.java`.
+The **MATSim program code** in this repository is distributed under the terms of the [GNU General Public License as published by the Free Software Foundation (version 2)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). The MATSim program code are files that reside in the `src` directory hierarchy and typically end with `*.java`, `*.py` or `*.R`.
 
 The **MATSim input files, output files, analysis data and visualizations** are licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
-<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br /> MATSim input files are those that are used as input to run MATSim. They often, but not always, have a header pointing to matsim.org. They typically reside in the `scenarios` directory hierarchy. MATSim output files, analysis data, and visualizations are files generated by MATSim runs, or by postprocessing.  They typically reside in a directory hierarchy starting with `output`.
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br /> MATSim input files are those that are used as input to run MATSim. They often, but not always, have a header pointing to matsim.org. They typically reside in the `input` or `scenarios` directory hierarchy. MATSim output files, analysis data, and visualizations are files generated by MATSim runs, or by postprocessing.  They typically reside in a directory hierarchy starting with `output`.
 
-**Other data files**, in particular in `original-input-data`, have their own individual licenses that need to be individually clarified with the copyright holders.
+**Other data files**, in particular in `original-input-data` or `https://svn.vsp.tu-berlin.de/repos/public-svn/`, have their own individual licenses that need to be individually clarified with the copyright holders.
 
 ### Note
 
@@ -55,8 +34,7 @@ Handling of large files within git is not without problems (git lfs files are no
 
 The Mexico City scenario has a command line interface providing the following options:
 
-[comment]: <> (TODO: create this png)
-![Scenario CLI](scenarios/cli.png "Scenario CLI")
+![Scenario CLI](cli.png "Scenario CLI")
 
 It can be used by using either of these methods:
 
@@ -76,6 +54,6 @@ It can be used by using either of these methods:
 2. Build the scenario using `mvnw package` 
 3. There should be a file directly in the `matsim-mexico-city` directory with name approximately as `matsim-mexico-city-1.0.jar`.
 4. Run this file from the command line using `java -jar matsim-mexico-city-1.0.jar --help` to see all possible options.
-    1. For example, one can disable lanes or run the 25pct scenario using the available options
+    1. For example, one can disable lanes or run the 10pct scenario using the available options
 5. Start this scenario using the default config by running `java -jar matsim-mexico-city-1.0.jar`
 6. "Open" the output directory.  You can drag files into VIA as was already done above.