Science Score: 65.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization matsim-vsp has institutional domain (www.vsp.tu-berlin.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: matsim-vsp
  • License: agpl-3.0
  • Language: Java
  • Default Branch: main
  • Size: 103 MB
Statistics
  • Stars: 0
  • Watchers: 11
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

MATSim Episim

Build Status license JDK Join the chat at https://gitter.im/matsim-episim-libs/community

This repository contains an epidemic simulation based on MATSim, provided by the Transport Systems Planning and Transport Telematics group of Technische Universität Berlin.

Dissemination of some scenarios and results produced with the methods in this repository can be found at https://matsim-vsp.github.io/covid-sim/.

How to use Episim

In order perform an epidemic simulation you first need an MATSim events file. To get started you can also use a provided event file from the OpenBerlin Scenario.

It is best to run the scenarios with your IDE from the org.matsim.run package. In org.matsim.run.modules you can find example scenarios that you may adapt or use to create your own configuration.

To run them you can create a standalone jar file with:

mvn package

and run it with (where OpenBerlinScenario is the name of the scenario you want to run):

java -jar matsim-episim-1.0-SNAPSHOT.jar --modules OpenBerlinScenario

Generating mobility traces events file

If you have a MATSim scenario you can also create your own event file to be used for an epidemic simulation. All that is needed is the population and the event file of one iteration.

Run DownSampleScenario to extract the necessary information:

java -jar matsim-episim-1.0-SNAPSHOT.jar scenarioCreation downSample 0.1 \
    --population <Path to plans.xml> --events <Path to events.xml>

This example will write a 10% sample into output that can be used in the subsequent steps.

Licenses

The MATSim program code in this repository is distributed under the terms of the GNU Affero General Public License. The MATSim program code are files that reside in the src directory hierarchy and typically end with *.java.

The MATSim input files, output files, analysis data and visualizations are licensed under a Creative Commons Attribution 4.0 International License. Creative Commons License
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.

Other data files, in particular in original-input-data, have their own individual licenses that need to be individually clarified with the copyright holders.

More information

For more information about the methodology and preliminary results, see VSP working paper https://dx.doi.org/10.14279/depositonce-9835 .

For more information about MATSim, see here: https://www.matsim.org/.

Owner

  • Name: VSP TU-Berlin
  • Login: matsim-vsp
  • Kind: organization
  • Location: Berlin

Technische Universität Berlin, Transport Systems Planning and Transport Telematics

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: MATSim Episim
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Christian
    family-names: Rakow
    email: rakow@vsp.tu-berlin.de
    affiliation: Technische Universität Berlin
    orcid: 'https://orcid.org/0000-0003-3760-2243'
  - given-names: Sebastian
    family-names: Müller
    email: mueller@vsp.tu-berlin.de
    affiliation: Technische Universität Berlin
    orcid: 'https://orcid.org/0000-0002-3103-8955'
  - email: rehmann@vsp.tu-berlin.de
    given-names: Jakob
    family-names: Rehmann
    affiliation: Technische Universität Berlin
  - given-names: Sydney
    family-names: Paltra
    email: paltra@vsp.tu-berlin.de
    affiliation: Technische Universität Berlin
  - given-names: Ricardo
    family-names: Ewert
    email: ewert@vsp.tu-berlib.de
    affiliation: Technische Universität Berlin
    orcid: 'https://orcid.org/0000-0002-6973-3099'
  - given-names: Kai
    family-names: Nagel
    email: nagel@vsp.tu-berlin.de
    affiliation: Technische Universität Berlin
    orcid: 'https://orcid.org/0000-0003-2775-6898'
url: "https://github.com/matsim-org/matsim-episim-libs"
date-released: 2022-12-09
year: 2022
version: 22.12
license: AGPL-3.0

GitHub Events

Total
  • Member event: 1
  • Push event: 5
  • Create event: 1
Last Year
  • Member event: 1
  • Push event: 5
  • Create event: 1

Dependencies

.github/workflows/build.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-java v1 composite
.github/workflows/publish.yaml actions
  • actions/checkout v2 composite
  • actions/setup-java v1 composite
pom.xml maven
  • com.github.matsim-org:matsim-episim-libs 2025.1
  • junit:junit 4.13.1 test
  • org.assertj:assertj-core 3.15.0 test
  • org.mockito:mockito-core 3.3.3 test
  • org.openjdk.jmh:jmh-core 1.23 test
  • org.openjdk.jmh:jmh-generator-annprocess 1.23 test
src/main/python/requirements.txt pypi
  • numpy >=1.19
  • optuna ==1.5.0
  • pandas >=1.1.1
  • scikit-learn >=0.23