README.md

STEM-AWAY Repository Template [Edit this title]

✏️ Add description of the project here.

Requirements

✏️ What are the requirements to install and run the project.

How to install

✏️ Add installation instructions here.

How to run

✏️ Add run instructions here. This includes necessary configurations as well as the commands used.

Repo's directory structure

The directory structure below shows the nature of files/directories used in this repo.

template_repo
├── CHANGELOG.md      <- Log of changes made
│
├── README.md
│
├── .gitignore        <- Specifies intentionally untracked files to ignore by git
│
├── configs           <- Dir to store config files. Conda env, requirements.txt, etc.
│
├── data              <- Dir structure.
│   ├── external      <- Data from third party sources
│   │── interim       <- Intermediate data that has been transformed.
│   ├── processed     <- The final, canonical datasets and results
│   └── raw           <- The original, immutable data dump
│
├── docs              <- Dir to store documentation.
│
├── models            <- Trained and serialized models, model predictions, or model summaries
├── notebooks         <- Dir to store Jupyter, R Markdown notebooks, etc.
│
├── src               <- Dir to store source code for this project

Team Structure and Contribution

Use this space to write your team names and their contribution.

References

Provide references of repositories, articles, other work used by your teams.

[DO NOT REMOVE]

Template repo derived from: http://drivendata.github.io/cookiecutter-data-science

Template created by: @samuelbharti