---
hide-toc: true
---

# Mushroom

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/minyez/mushroom/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/minyez/mushroom/tree/master)
[![codecov](https://codecov.io/github/minyez/mushroom/graph/badge.svg?token=SM7R1XB2VW)](https://codecov.io/github/minyez/mushroom)

Mushroom is a **M**ulti-f**U**nctional, **S**imple and **H**elpful **R**esearch t**OO**lkit for **M**aterial science.
This is just a contrived name for yet another analysis tool for scientific computations in material science.

```{toctree}
:hidden:

getstarted
customize
```