Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit 03b39a0

Browse files
committed
Update the instructions within the readme
1 parent 42d05f7 commit 03b39a0

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.rst

+42-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,51 @@ fz-td-recipe
44
A wrapper around a connectome building recipe used by BlueBrain tools, to be either
55
defined in JSON/YAML or XML (deprecated).
66

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+
746
Acknowledgment
8-
==============
47+
--------------
948
The development of this software was supported by funding to the Blue Brain Project,
1049
a research center of the École polytechnique fédérale de Lausanne (EPFL),
1150
from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.
1251

1352
Copyright (c) 2021-2024 Blue Brain Project/EPFL
53+
54+
.. _SONATA extension: https://sonata-extension.readthedocs.io/en/latest/recipe.html

0 commit comments

Comments
 (0)