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: docs/tutorials/configuration/index.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,30 @@ and some questions will show up:
19
19
[?] How would you name the default flora? Please keep the default value if this is not clear to you.: flora
20
20
```
21
21
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
+
22
46
!!! warning "config file already exists"
23
47
If a config file (`~/.dataherb/config.json`) is already created, a warning will be shown:
24
48
@@ -67,7 +91,8 @@ Once the `dataherb configure` command is run, a `config.json` file will be creat
67
91
{
68
92
"workdir": "~/dataherb",
69
93
"default": {
70
-
"flora": "flora"
94
+
"flora": "flora",
95
+
"aggregrated": false
71
96
}
72
97
}
73
98
```
@@ -76,10 +101,11 @@ Once the `dataherb configure` command is run, a `config.json` file will be creat
76
101
|---|---|---|
77
102
|`workdir`|`~/dataherb`| The work directory for dataherb. |
78
103
|`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`. |
79
105
80
106
81
107
!!! note "More about `workdir`"
82
108
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`)
83
109
84
110
!!! 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