Skip to content

Commit bad9902

Browse files
abhardwaj73janosh
andauthored
Added documentation about JSONStore usage within Installation (#945)
* Added documentation about JSONStore usage within Installation * tweak --------- Co-authored-by: Janosh Riebesell <[email protected]>
1 parent f5ab8cc commit bad9902

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/user/install.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,30 @@ from) by clicking "Network Access" (under "Security" in the left hand menu) and
267267
"Add IP address".
268268
````
269269

270+
````{note}
271+
If you do not have access to a Mongo database, you can run `atomate2` using a local `.json` file
272+
to store outputs using the following `jobflow.yaml` file.
273+
274+
```yaml
275+
JOB_STORE:
276+
docs_store:
277+
type: JSONStore
278+
uri: <<PATH>>
279+
read_only: True
280+
additional_stores:
281+
data:
282+
type: JSONStore
283+
uri: <<PATH>>
284+
read_only: True
285+
```
286+
287+
The user doesn't need to have the file at the given `<<PATH>>`, since we have set `read_only: True`.
288+
In case the file isn't available, a new file with the name mentioned in the `<<PATH>>` will be generated.
289+
290+
**Note that this approach has limitations - it cannot handle simultaneous writes and so is not suitable for high-throughput work.**
291+
````
292+
293+
270294
Atomate2 uses two database collections, one for small documents (such as elastic
271295
tensors, structures, and energies) called the `docs` store and another for large
272296
documents such as band structures and density of states called the `data` store.

0 commit comments

Comments
 (0)