Skip to content

Commit ee407d1

Browse files
committed
docs(database): add install instruction
1 parent 505f313 commit ee407d1

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

docs/guides/database.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ parallel execution is not efficient at all.
1515
### Requirements and Configuration
1616
Requirement: MySQL database is set up.
1717

18-
1. Add a `credentials.yaml` file in `carps/experimenter` with the following content:
18+
1. Install the database dependencies with `pip install carps[database]`.
19+
20+
2. Add a `credentials.yaml` file in `carps/experimenter` with the following content:
1921
```yaml
2022
CREDENTIALS:
2123
Database:
@@ -26,7 +28,7 @@ CREDENTIALS:
2628
server: mysql_server
2729
port: 3306 (most likely)
2830
```
29-
2. Edit `carps/experimenter/py_experimenter.yaml` by setting:
31+
3. Edit `carps/experimenter/py_experimenter.yaml` by setting:
3032
```yaml
3133
PY_EXPERIMENTER:
3234
n_jobs: 1

0 commit comments

Comments
 (0)