Model/model_data/README.md

# Environment setup

We're using conda to manage environments to circumvent the
issues with Mac M1. This documentation will also cover Pycharm setup.

We're working in python 3.10 so

```commandline
conda create -n hestia-data python=3.10
```

Then activate the environment

```commandline
conda activate hestia-data
```

To set up with Pycharm, run

```commandline
which python
```    

and grab the path to the python executable. Then in Pycharm, go to
Settings > Project > Python Interpreter and click the gear icon
to add a new interpreter. Select Conda and either paste the path to the python executable
and click OK, or select the conda environment from the dropdown.

You may need to restart Pycharm for the new interpreter to be recognised.

To install project dependencies navigate to /model_data and run

```commandline
pip install -r requirements.txt
```

### Running Tests

If you are not in a virtual environment, activate it with

```commandline
conda activate envName
```

Then run

```commandline
pytest --cov-config=model_data/.coveragerc --cov=model_data
```