Merge pull request #3 from EarthScope/chanagan

Chanagan

README.md

@@ -4,23 +4,58 @@ with SPOTL, BAYTAP-08, Jupyter Scipy Notebooks.
 
 This directory will be mounted to the container, so any figures, data, or local changes will be saved after the container shuts down.
 
-## Usage:
-Clone the repo:
+## Quick-start (if Docker is already installed):
+
+If you have git installed, you can clone the repository with the following:
 > git clone [email protected]:EarthScope/strain-processing-notebooks.git
 
-Run the following script, which will get the docker image from the github container 
-registry, mount the notebooks directory to your local directory, and start a Juptyer lab
-server. 
+Alternatively, you can download the repository with this link: 
+> https://github.com/EarthScope/strain-processing-notebooks/archive/refs/heads/main.zip
+
+Run the ```run_docker.sh``` script from the downloaded (and unzipped) folder with the following command: 
+
+For Mac/Linux Terminal:
 > ./run_docker.sh
 
+FOr Windows PowerShell:
+> sh .\run_docker.sh
+
+This will get the docker image from the github container registry, mount the notebooks directory to your local directory, and start a Juptyer lab server. 
+
 Once the kernel has started, click the last link in the terminal to load Jupyer Lab in a browser
 >  http://127.0.0.1:8888/lab?token=...
 
-Some example notebooks are stored for reference in the container image under examples
+If you are unfamiliar with Jupyter, we suggest taking a look through the Jupyter tutorials linked under the ```help > Jupyter Reference``` menu in Jupyter Lab. 
+
+Finally, test that the environment is working properly by running through the ```environment-test.ipynb``` notebook in the ```notebooks``` directory. 
+
+Some example notebooks are stored for reference in the container image under examples.
 
 If you want to modify notebooks and build your own, work in the notebooks directory so that 
 your changes will be saved after the container stops.
 
+## Mac pre-installation
+
+Follow the instructions to install Docker Desktop (https://docs.docker.com/desktop/install/mac-install/).
+
+Now you should be able to follow the quick-start instructions.
+
+## Linux pre-installation
+
+Follow the instructions to install Docker Desktop  (https://docs.docker.com/desktop/install/linux-install/).
+
+Now you should be able to follow the quick-start instructions.
+
+## Windows pre-installation (if Docker is not already installed)
+
+Follow the instructions to install Windows Subsystem for Linux (WSL) from the Windows PowerShell window (https://learn.microsoft.com/en-us/windows/wsl/install)
+- We tested and suggest installing setting the Ubuntu distribution as the default 
+- Make sure that the WSL and Virtual Machine Platform features are enabled, and if things still aren't running, make sure Virtualization is enabled in the BIOS settings on startup
+- If your system does not work with wsl, you may need to follow the Hyper-V instructions instead
+
+Follow the instructions to install Docker with wsl backend (https://docs.docker.com/desktop/install/windows-install/).
+
+Now you should be able to follow the quick-start instructions.
 
 ## Linked images:
 - ghcr.io/earthscope/fortran-base-image