README

The Faraday Institution Multi-Scale Modelling (MSM) collaboration has a dedicated wiki to share information. This repository is here to host any supporting material, such as data, codes and (interactive) plots.

Report any issue, request and start a discussion as a 'GitHub Issue'.

Adding your model

Make sure you include a brief description of your model (or plots and code) both here and in the [wiki]((http://multiscalemodelling.pbworks.com).

The recommended way to contribute to this dedicated GitHub repository is following these steps (see further details in this guide and also in Ryan Pepper's material):

  1. Fork and clone a copy from the GitHub repository.

  2. Update your personal copy.

  3. Track upstream: keeping your copy up-to-date with the main one.

  4. Submit a Pull Request to the main a repository code.

Repository Organization

├── LICENSE
├── README.md          <- Introduction to the Live Review set up and how to contribute.
│

├── pycode             <- Folder to contain code in python
└── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
    └── img            <- Static figures to be used in the notebooks
    └── data           <- Data needed to be run the notebooks
Nextnotebooks

Last updated