Skip to content

Commit d488734

Browse files
docs: update README with development setup instructions (#443)
1 parent bbca627 commit d488734

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,20 @@ Fri 0 4
152152

153153
Note that these do have to be installed by the user separately.
154154

155+
## Development Setup
156+
157+
To set up a local development environment for linopy and to run the same tests that are run in the CI, you can run:
158+
159+
```sh
160+
python -m venv venv
161+
source venv/bin/activate
162+
pip install uv
163+
uv pip install -e .[dev,solvers]
164+
pytest
165+
```
166+
167+
The `-e` flag of the install command installs the `linopy` package in editable mode, which means that the virtualenv (and thus the tests) will run the code from your local checkout.
168+
155169
## Citing Linopy
156170

157171
If you use Linopy in your research, please cite the following paper:

0 commit comments

Comments
 (0)