Skip to content

Commit 9c5864d

Browse files
committed
update docs for switching to folder
1 parent 517a220 commit 9c5864d

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

docs/tutorials/configuration/index.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,30 @@ and some questions will show up:
1919
[?] How would you name the default flora? Please keep the default value if this is not clear to you.: flora
2020
```
2121
22+
The first question is setting the workdir.
23+
24+
!!! warning "Different ways of perserving the metadata"
25+
We have two different ways of perserving the flora meta data.
26+
27+
1. Using a single file for all the datasets.
28+
2. Using a folder for each dataset.
29+
30+
`dataherb` supports both. By default, we will use folders. For the above configuration, we will find the folder for all the flora metadata at `~/dataherb/flora/flora`.
31+
32+
Note that `~/[workdir]/flora/` is the path where we put all the flora metadata. If the answer to the second question, aka name of the flora, is set to `flora2`, we will have all the flora metadata located at `~/[workdir]/flora/flora`2`.
33+
34+
We can have multiple flora, for example, we can have two, `flora` and `flora2`
35+
36+
```bash
37+
flora
38+
├── flora
39+
│ └── git-dataherb-python-demo-dataset
40+
│ └── dataherb.json
41+
└── flora2
42+
└── git-dataherb-python-demo-dataset-2
43+
└── dataherb.json
44+
```
45+
2246
!!! warning "config file already exists"
2347
If a config file (`~/.dataherb/config.json`) is already created, a warning will be shown:
2448

@@ -67,7 +91,8 @@ Once the `dataherb configure` command is run, a `config.json` file will be creat
6791
{
6892
"workdir": "~/dataherb",
6993
"default": {
70-
"flora": "flora"
94+
"flora": "flora",
95+
"aggregrated": false
7196
}
7297
}
7398
```
@@ -76,10 +101,11 @@ Once the `dataherb configure` command is run, a `config.json` file will be creat
76101
|---|---|---|
77102
| `workdir` | `~/dataherb` | The work directory for dataherb. |
78103
| `default.flora` | `flora` | The name of the flora to be used by default. For example, the value `flora` means we will use the `flora.json` database in the folder `(workdir setting in the above row)/flora/flora.json`. |
104+
| `default.aggregrated` | `false` | Whether to use a single json file for all the flora metadata. It is highly recommended to set it to `false`. |
79105

80106

81107
!!! note "More about `workdir`"
82108
By default, two folders will be created inside it: `~/dataherb/flora` (default storage for all flora) and `~/dataherb/serve` (the cache folder for the website of all datasets when we run `dataherb serve`)
83109

84110
!!! note "More about `default.flora`"
85-
If `workdir` is set to `~/dataherb`, then the database will be `~/dataherb/flora/flora.json`. If the value of `default.flora` is set to `abc`, then the database will be `~/dataherb/flora/abc.json`.
111+
If `workdir` is set to `~/dataherb`, then the database will be `~/dataherb/flora/flora`. If the value of `default.flora` is set to `abc`, then the database will be `~/dataherb/flora/abc`.

0 commit comments

Comments
 (0)