# README

The [Faraday Institution](https://faraday.ac.uk/) [Multi-Scale Modelling](http://energysuperstore.org/esrn/multiscale-modelling/) (MSM) collaboration has a [dedicated wiki](http://multiscalemodelling.pbworks.com) 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'](https://github.com/FaradayInstitution/msm_live_review/issues).

## 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](https://github.com/FaradayInstitution/msm_live_review) is following these steps (see further details in this [guide](https://msm.gitbook.io/msm/contributing2github) and also in Ryan Pepper's [material](https://scientific-programming.github.io/)):

1. Fork and clone a copy from the [GitHub repository](https://github.com/FaradayInstitution/msm_live_review).
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
```