diff --git a/README.md b/README.md index bbe2a23ed421a5e1031471445d89659a341ee74d..96f5a6419e4db19b72c2532fabef7997fb11e712 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,22 @@ Please note that it has been tested with a Linux system. ### Organisation of this repository This repository contains different parts: -* + +```sh +├── data +├── Data_Preparation +├── Models +│ ├── AVC +│ ├── GeneralPop +│ └── VICAN +├── SNDSGenerator +└── snds_sqltordf +``` + +* `data` contains some resources data useful to create a database mimicking some real characteristics of the SNDS. +* `Data_Preparation` contains, on the one side, bash and python scripts used to set up files needed by the generator. On the other side, it contains a set of notebooks that details how the random distributions have been generated from the raw-public datasets +* `Models` contains specific instanciations of the generator. Currently, we propose three different bases: AVC, GeneralPop and VICAN +* `SNDSGenerator` contains the generator engine ### Installation