Skip to content

Add beginner notes for running notebooks #36

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

Open
LeKingArt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add beginner notes for running notebooks #36

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: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ After installing SCARR and consideration of the usage warning, please proceed as
* select a Jupyter notebook from the `jupyter` subdirectory or its [corresponding repository](https://github.com/decryptofy/scarr-jupyter).
* determine corresponding example data set(s) and download from Box.com: [click here](https://oregonstate.box.com/s/flpkr969do6v1h5a8qwfw5t49c7ivzgl)
* run Jupyter notebook to use SCARR
*
## Beginner Notes for Running Notebooks

SCARR examples use Jupyter notebooks, so beginners should be comfortable with basic Python and opening notebook files. Before running a notebook, users should first install SCARR and download the matching example dataset listed in the Getting Started steps. The notebooks can be opened with any Jupyter-compatible tool, such as Jupyter in a browser, VS Code with the Jupyter extension, or PyCharm. New users should start with the first notebook in the `jupyter` folder and make sure the data files are in the expected location before running the cells.

***Important note for downloading from Box.com:*** we are currently in the process of finding optimized ways for making the download process more convenient and more reliable. Until then, please avoid downloading whole directories that also have trace files in them, as Box.com will attempt to create a .zip prior to the download (causing a timeout while doing so). Select and download data sets only individually.

Expand Down