wsimson tristan-deep commited on
Commit
8dd4e90
·
1 Parent(s): b0cef72

ubc: add zea process example to the Module A and C READMEs (#87)

Browse files

- ubc: add zea process example to the Module A and C READMEs (7ec3c44039e55fe01f007f4f8327bca574e6560f)


Co-authored-by: Tristan Stevens <tristan-deep@users.noreply.huggingface.co>

Files changed (2) hide show
  1. ubc/module_A/README.md +11 -1
  2. ubc/module_C/README.md +11 -1
ubc/module_A/README.md CHANGED
@@ -90,7 +90,17 @@ Acquisition and simulation details:
90
 
91
  ## Processing the Dataset
92
 
93
- The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/ubc/module_A/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline.yaml` definition in this folder and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub.
 
 
 
 
 
 
 
 
 
 
94
 
95
  `reconstruct.py` reconstructs one frame (default `case_1.83/ubc_swave_cirs_1.83_p10_f13.hdf5`); [`reconstruct_multiframe.py`](https://github.com/open-h/OpenH-RF/blob/main/datasets/ubc/module_A/reconstruct_multiframe.py) reconstructs the temporal sequence at one motor plane (`CASE_ID`, `PLANE`, `N_FRAMES`) into an animated GIF.
96
 
 
90
 
91
  ## Processing the Dataset
92
 
93
+ The acquisitions can be processed with the `pipeline.yaml` definition in this folder and the [zea library](https://github.com/tue-bmd/zea).
94
+
95
+ `zea` streams the data from the Hugging Face Hub and processes it according to the pipeline. You can try it out with the following command:
96
+
97
+ ```bash
98
+ zea process \
99
+ --dataset hf://nvidia/OpenH-RF/ubc/module_A/acquisitions/case_1.83/ubc_swave_cirs_1.83_p10_f13.hdf5 \
100
+ --config hf://nvidia/OpenH-RF/ubc/module_A/pipeline.yaml
101
+ ```
102
+
103
+ Alternatively, you can use the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/ubc/module_A/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF).
104
 
105
  `reconstruct.py` reconstructs one frame (default `case_1.83/ubc_swave_cirs_1.83_p10_f13.hdf5`); [`reconstruct_multiframe.py`](https://github.com/open-h/OpenH-RF/blob/main/datasets/ubc/module_A/reconstruct_multiframe.py) reconstructs the temporal sequence at one motor plane (`CASE_ID`, `PLANE`, `N_FRAMES`) into an animated GIF.
106
 
ubc/module_C/README.md CHANGED
@@ -95,7 +95,17 @@ The element geometry and dimensions are simulation assumptions, not measured pro
95
 
96
  ## Processing the Dataset
97
 
98
- The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/ubc/module_C/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline.yaml` definition in this folder and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub.
 
 
 
 
 
 
 
 
 
 
99
 
100
  Set `ZEA_FILE` and `FRAME` at the top of the script to pick a frame (default `session_01/session_01_f1306.hdf5`).
101
 
 
95
 
96
  ## Processing the Dataset
97
 
98
+ The acquisitions can be processed with the `pipeline.yaml` definition in this folder and the [zea library](https://github.com/tue-bmd/zea).
99
+
100
+ `zea` streams the data from the Hugging Face Hub and processes it according to the pipeline. You can try it out with the following command:
101
+
102
+ ```bash
103
+ zea process \
104
+ --dataset hf://nvidia/OpenH-RF/ubc/module_C/acquisitions/session_01/session_01_f1306.hdf5 \
105
+ --config hf://nvidia/OpenH-RF/ubc/module_C/pipeline.yaml
106
+ ```
107
+
108
+ Alternatively, you can use the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/ubc/module_C/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF).
109
 
110
  Set `ZEA_FILE` and `FRAME` at the top of the script to pick a frame (default `session_01/session_01_f1306.hdf5`).
111