# Environment Setup

`cost-eco-model-linker` is not a registered Python package. To set up for local use,
clone the repository.

Package environment and dependencies are managed with [`uv`](https://docs.astral.sh/uv/getting-started/installation/).

This can be installed in the global Python environment with:

```shell
$ pip install uv
```


Once the repository is cloned,
simply run:

```shell
# Initialize project environment and install all dependencies
$ uv sync

# This should change the initial prompt to:
(cost-eco-model-linker) $
```

## Development setup

Assuming the current directory is the project root:

```shell
# Add formatter and linter
(cost-eco-model-linker) $ uv sync --group lint

# Add dev packages
(cost-eco-model-linker) $ uv sync --group dev
```

In VS code, the corresponding virtual environment can be selected by selecting the interpreter in the bottom right of the screen:

<img src="./_static/figs/prod/select_interpreter.png" width="800">

And then selecting the virtual environment:

<img src="./_static/figs/prod/select_environment.png" width="800">

To use `cost-eco-model-linker`,

Copies of the cost models and associated configuration must be had to use
`cost-eco-model-linker`.

See [cost_models](cost_models.md) for further details.