You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,16 @@
10
10
11
11
Provide a Python API for [WRENCH](https://wrench-project.org). This API is built on top of WRENCH's [REST API](https://wrench-project.org/wrench/latest/rest_api.html).
12
12
13
-
# Dependencies and Installation
13
+
# Dependencies
14
14
15
15
-[WRENCH](https://github.com/wrench-project/wrench) master branch and its dependencies
16
16
- You must compile the `wrench-daemon` target (i.e., `make wrench-daemon`) during the build process before doing the usual (`sudo make install`)
17
-
- Run `python3 -m build` to build the package (you may need to install the `build` Python package).
18
-
- Run `python3 -m pip install ./dist/wrench-*.whl` to install the package
19
17
20
-
# Examples and API Documentation
18
+
# Installation
19
+
20
+
A simple `pip install .` should do.
21
+
22
+
# Examples and Documentation
21
23
22
24
Example simulators are provided in the `examples` directory. See the `README` file therein for information on what these examples are and how to run them.
0 commit comments