From 115de8b29505d6fedb0a2e117dd3b646741684b9 Mon Sep 17 00:00:00 2001 From: Lars Date: Wed, 8 Oct 2025 13:54:33 +0000 Subject: [PATCH 1/3] readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 785a327ad..8d372ca2c 100644 --- a/README.md +++ b/README.md @@ -80,3 +80,18 @@ Visualization: ■ Grid Import ■ Grid Export ■ Forecast ■ Bat 1 Charge Power ■ Bat 1 Discharge Power ■ Bat 2 Charge Power ■ Bat 2 Discharge Power ``` + +### Development + +To develop the evopt codebase, ensure `uv` and `make` are available on your system. +Installation instructions for `uv` [can be found here](https://docs.astral.sh/uv/getting-started/installation/). + +Once `uv` and `make` are available on the PATH, you can run `make run` to set up the project environment and run the optimizer service. + +Linting and formatting is run with `make lint`. +The test suite is run with `make test`. +To add a new dependency to the project, run `uv add `. +To upgrade all depdendencies to their latest version, run `make upgrade`. + +If you are using VSCode, we recommend the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python), [autopep8](https://marketplace.visualstudio.com/items?itemName=ms-python.autopep8), and [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) extensions. +Set up `autopep8` as your formatter for Python files. From 5e4abaa8c471433eef763d209951c544ce08623d Mon Sep 17 00:00:00 2001 From: Lars Date: Mon, 13 Oct 2025 13:49:52 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8d372ca2c..21f15b47d 100644 --- a/README.md +++ b/README.md @@ -93,5 +93,7 @@ The test suite is run with `make test`. To add a new dependency to the project, run `uv add `. To upgrade all depdendencies to their latest version, run `make upgrade`. +To make sure that your contributes pass the CI pipeline, make sure you run `make lint` and `make test` before comitting or pushing your code. + If you are using VSCode, we recommend the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python), [autopep8](https://marketplace.visualstudio.com/items?itemName=ms-python.autopep8), and [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) extensions. Set up `autopep8` as your formatter for Python files. From f98e00813ba026d2c5bd8f6cec6473f790797b18 Mon Sep 17 00:00:00 2001 From: Lars Date: Mon, 13 Oct 2025 13:51:23 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 21f15b47d..a1e6c6ba0 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ The test suite is run with `make test`. To add a new dependency to the project, run `uv add `. To upgrade all depdendencies to their latest version, run `make upgrade`. -To make sure that your contributes pass the CI pipeline, make sure you run `make lint` and `make test` before comitting or pushing your code. +To make sure that your contributions pass the CI pipeline, run `make lint` and `make test` before comitting or pushing your code. If you are using VSCode, we recommend the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python), [autopep8](https://marketplace.visualstudio.com/items?itemName=ms-python.autopep8), and [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) extensions. Set up `autopep8` as your formatter for Python files.