Skip to content

Commit c0eb6cd

Browse files
author
Thomas Günther
committed
Add developer installation to README.md
Signed-off-by: Thomas Günther <[email protected]>
1 parent f0e4d70 commit c0eb6cd

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,35 @@ The focus of CIMpy is on the support of the Common Grid Model Exchange Standard
1111
CIMpy's documentation you can find [here](http://sogno-platform.github.io/cimpy/).
1212
The documentation provides instructions on CIMpy's installation, getting started examples and the possibility to browse through the supported CIM class codebases.
1313

14+
## Development
15+
16+
### Developer Installation
17+
18+
```bash
19+
git clone https://github.com/sogno-platform/cimpy.git
20+
cd cimpy
21+
pip install -e .[dev]
22+
```
23+
24+
Run pre-commit checks manually:
25+
26+
```bash
27+
pre-commit run --all-files
28+
```
29+
30+
Install pre-commit hook to run it automatically:
31+
32+
```bash
33+
pre-commit install
34+
```
35+
1436
## License
1537

1638
This project is released under the terms of the [Apache License 2.0](./LICENSE).
1739

18-
## Publication
40+
## Publications
1941

2042
If you are using CIMpy for your research, please cite the following paper in your publications:
2143

2244
Dinkelbach, J., Razik, L., Mirz, M., Benigni, A., Monti, A.: Template-based generation of programming language specific code for smart grid modelling compliant with CIM and CGMES.
23-
J. Eng. 2023, 113 (2022). [https://doi.org/10.1049/tje2.12208](https://doi.org/10.1049/tje2.12208)
45+
J. Eng. 2023, 1-13 (2022). [https://doi.org/10.1049/tje2.12208](https://doi.org/10.1049/tje2.12208)

0 commit comments

Comments
 (0)