Skip to content

Add Development instructions to README.md #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andig merged 3 commits into from
Oct 18, 2025
Merged

Add Development instructions to README.md #33

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
115de8b
readme
lfloeer Oct 8, 2025
5e4abaa
Update README.md
lfloeer Oct 13, 2025
f98e008
Update README.md
lfloeer Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,20 @@ 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 <dependency>`.
To upgrade all depdendencies to their latest version, run `make upgrade`.

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.