search

sensein / b2aiprep

Apache License 2.0
5 stars 6 forks source link

Update README.md to specify bids_dir parameter in Streamlit example #72

Closed DebuggerDan closed 4 weeks ago

DebuggerDan commented 1 month ago

This is a simple documentation-specific pull request for README.md.

Specifically, the further specification of how Streamlit should be run, with a bids_dir argument being passed & notes a possible error regarding non-initialized bids_dir data whilst using Streamlit.

Specifically, the following simple changes are proposed for README.md: streamlit run src/b2aiprep/app/Dashboard.py to streamlit run src/b2aiprep/app/Dashboard.py [path to BIDS directory]

Lastly, a note was added regarding a possible bug encountered whilst attempting to use Streamlit: After the Streamlit dashboard opens, please wait for the BIDS data to be loaded while on the Dashboard page, as an error regarding a non-initialized bids_dir directory may pop up if the BIDS data has not been fully loaded.

alistairewj commented 4 weeks ago

Ah yes, great fix, thank you!