README.md

# Ensemble Comparison

This program performs a comparison between a simple traditional ensemble and a cluster-based ensemble.

## Requirements

- Python 3.7.6
- UNIX based shell such as bash or z shell
- Combined dataset in netDF format

## How to run the program

- Add the combined dataset in netCDF format in the `files` directory with the name `combined-data.nc`. Or go to the `main.py` file and update the `Data` class instantiation call to match your dataset location.

- Open the terminal and navigate to the the project's directory `cd <path/to/project>`.

- Run `sudo pip3 install -r requirements.txt` or `sudo pip install -r requirements.txt` in order to install the project's dependencies listed in the `requirements.txt`. (Creating a virtual environment is recommended before this stage so that the dependencies don't get installed directly into your machine).

- Run `python3 main.py` or `python main.py` to execute the program.

- Verify the output file was generated in the `files` directory with the name `comparison.nc`.

## Notes

These instructions assume your operating system is UNIX based, for example MacOS. Windows might require different steps and setup.