Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update doc #211

Merged
merged 1 commit into from
Sep 19, 2023
Merged

Update doc #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/tutorial/plastic_beads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ machine, respectively. You will also need to install
to stream the data from files.

We are going to use the *plastic beeds* dataset offered by
[TomoBank](https://tomobank.readthedocs.io/en/latest/#). Open its homepage and Navigate
[TomoBank](https://tomobank.readthedocs.io/en/latest/#). Go to the homepage, and then navigate
to `Datasets/KBLT` and download the file `2_plastic_beeds_RGB.h5`.

## Running
Expand All @@ -22,7 +22,7 @@ to `Datasets/KBLT` and download the file `2_plastic_beeds_RGB.h5`.

Open a terminal and run:
```sh
foamstream-tomcat --datafile <path>/2_plastic_beeds_RGB.h5 --pdata tomo -pflat flat
foamstream-tomo --datafile <Your/folder/2_plastic_beeds_RGB.h5> --pdata tomo -pflat flat
```

### Starting the reconstruction server
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/user_guide/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ We recommend using [foamstream](https://github.com/zhujun98/foamstream.git).
```sh
pip install foamstream

foamstream-tomcat --datafile pet1
foamstream-tomo --datafile <Your/HDF5 file/path>
```

Please feel free to use your own file streamer as long as the [data protocol](./data_protocol.md) is compatible.