Skip to content

Commit c491a2e

Browse files
committed
update readme
1 parent 9f5cf17 commit c491a2e

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,27 @@
77
</h1>
88

99
Pasteur is a system for data synthesis.
10-
This readme will contain relevant information soon.
11-
For now, head to the link below to reproduce the experiments.
10+
This readme is under construction.
1211

1312
## Reproducibility
14-
[Reproducibility Readme](notebooks/paper)
13+
You can find the experiment files that can be used to reproduce the paper
14+
about Pasteur [here](https://github.com/pasteur-dev/pasteur/tree/paper/notebooks/paper).
15+
16+
## Usage
17+
You can install Pasteur with pip.
18+
```bash
19+
pip install pasteur
20+
```
21+
22+
By default, Pasteur is disabled. To use it with a kedro project, add the
23+
`PASTEUR_MODULES` keyword in your `settings.py` file, which will enable it.
24+
```python
25+
from pasteur.extras import get_recommended_modules
26+
27+
PASTEUR_MODULES = get_recommended_modules()
28+
```
29+
30+
Currently, there does not exist a template project from which to start upon.
31+
This repository is a working Pasteur project and is what was used to develop it.
32+
The module `./src/project` is a kedro project with configs in `./conf` and it is
33+
the one that was used to develop pasteur.

0 commit comments

Comments
 (0)