Skip to content

README.md

Latest commit

 

History

History
32 lines (20 loc) · 896 Bytes

README.md

File metadata and controls

32 lines (20 loc) · 896 Bytes

Examples accompanying the LibMobility paper

Usage:

Start by cloning the repository:

$ git clone https://github.com/stochasticHydroTools/libmobility-paper-examples

Getting the dependencies

Dependencies are handled with conda, and can be installed with the following command in the root of the repository:

$ conda env create
$ conda activate libmobility-examples

Running the examples

This repository contains a directory for each example showcased in the article.

References

TODO: [INSERT PAPER REFERENCE WHEN WE HAVE A DOI]

Contributing

  • Work in a separated branch and do a pull request to master with your changes
  • Add the required dependencies for your scripts to the environment file
  • Create a new folder and place your scripts there, along with a README.md describing how to use them