This repository was archived by the owner on Feb 26, 2025. It is now read-only.
Commit 03b39a0 1 parent 42d05f7 commit 03b39a0 Copy full SHA for 03b39a0
File tree 1 file changed +42
-1
lines changed
1 file changed +42
-1
lines changed Original file line number Diff line number Diff line change @@ -4,10 +4,51 @@ fz-td-recipe
4
4
A wrapper around a connectome building recipe used by BlueBrain tools, to be either
5
5
defined in JSON/YAML or XML (deprecated).
6
6
7
+ Installation
8
+ ------------
9
+
10
+ To install the latest stable release, please use:
11
+
12
+ .. code-block :: console
13
+
14
+ $ pip install fz-td-recipe
15
+
16
+ Or to get the latest code, build it from ``git ``:
17
+
18
+ .. code-block :: console
19
+
20
+ $ gh repo clone BlueBrain/fz-td-recipe
21
+ $ cd fz-td-recipe
22
+ $ pip install .
23
+
24
+ Usage
25
+ -----
26
+
27
+ A small command line utility is provided to convert legacy XML recipes and validate if a
28
+ JSON or YAML file conforms to the recipe schema:
29
+
30
+ .. code-block :: console
31
+
32
+ $ fz-td-recipe convert recipe.xml recipe.json
33
+ $ fz-td-recipe validate recipe.json
34
+
35
+ More details and features can be accessed with i.e.:
36
+
37
+ .. code-block :: console
38
+
39
+ $ fz-td-recipe validate --help
40
+
41
+ Further Documentation
42
+ ---------------------
43
+
44
+ The recipe format is documented within the `SONATA extension `_ by the Blue Brain Project.
45
+
7
46
Acknowledgment
8
- ==============
47
+ --------------
9
48
The development of this software was supported by funding to the Blue Brain Project,
10
49
a research center of the École polytechnique fédérale de Lausanne (EPFL),
11
50
from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.
12
51
13
52
Copyright (c) 2021-2024 Blue Brain Project/EPFL
53
+
54
+ .. _SONATA extension : https://sonata-extension.readthedocs.io/en/latest/recipe.html
You can’t perform that action at this time.
0 commit comments