Add README file for results importer utility

EmpaEconversion · Oct 27, 2023 · a2c90aa · a2c90aa
1 parent e66d16f
commit a2c90aa
Show file tree

Hide file tree

Showing 2 changed files with 177 additions and 0 deletions.
diff --git a/utils/README.md b/utils/README.md
@@ -0,0 +1,11 @@
+# Results Importer
+
+This utility can be used to import into AiiDA results obtained by means other than the AiiDA-Aurora workflow.
+
+For example, when results are obtained from EC-lab, `.mpr` files can be converted into `.json` files resembling those produced by `tomato`. This utility will import such files as AiiDA `ArrayData` and recreate the (limited) provenance graph (below) in a near-identical way to that which would have been produced if the calculation was executed via AiiDA.
+
+The logic is contained in `results_importer.py`. A notebook is provided as a convenient template to get started.
+
+### `verdi node graph generate --identifier pk -f svg -e circo <WorkChain-pk>`
+
+<img src="./graph.svg" alt="AiiDA provenance graph replicated from imported results" width="900" height="600" />
diff --git a/utils/graph.svg b/utils/graph.svg