The WoMAD Code

Let's go through the WoMAD code: Usage, Installation, and the Structure of our Repository.

Installation and Usage of the WoMAD Package

[RTFM for Python packages ... please stand by for installation and usage guide ;)]

The Repository

Look at this refreshing tree of chaos, the structure of the repo:

.
├── data
│   ├── model_ready
│   └── processed
├── docs
│   ├── img
│   ├── index.md
│   ├── the_code.md
│   └── the_science.md
├── figures
├── LICENSE
├── Makefile
├── mkdocs.yml
├── models
│   └── README.md
├── pyproject.toml
├── README.md
├── tests
│   └── test_all_modules.py
├── WoMAD
│   ├── data_module.py
│   ├── hyperparameter_module.py
│   ├── __init__.py
│   ├── model_setup_module.py
│   ├── model_train_module.py
│   ├── model_valid_module.py
│   ├── result_interp_module.py
│   └── WoMAD_config.py
└── WoMAD_main.py

Now, let's go through these files one by one.