diff --git a/installation/README.md b/installation/README.md index 3bc52823..6d647662 100644 --- a/installation/README.md +++ b/installation/README.md @@ -46,7 +46,7 @@ Move the the downloaded zip file (`python-for-hydrology-main.zip`) to the select # Test the class environment -After successful installation of the class environment and downloading the class repository navigate to the `installation` directory in class repository. +After successful installation of the class environment and downloading the class repository navigate to the `installation` directory in class repository. In Windows, this is done in Miniforge Prompt. ```shell cd python-for-hydrology/installation diff --git a/notebooks/README.md b/notebooks/README.md new file mode 100644 index 00000000..8adaccd4 --- /dev/null +++ b/notebooks/README.md @@ -0,0 +1,64 @@ +# Jupyter Lab + +Jupyter Lab will be used to view and interact with Python Notebooks. + +## Starting Jupyter + +### Windows + +1. Open Miniforge Prompt. Startup steps (2-4) are done within Miniforge. + +2. Navigate to the notebooks folder: + +For example: + +```shell +cd python-for-hydrology/notebooks/part0_python_intro +``` + +3. Activate the pyclass environment (this assumes the installation steps were already performed). + +```shell +conda activate pyclass +``` + +4. Launch JupyterLab with the command: + +```shell +jupyter lab +``` + +A browser should open up: + +Launch Jupyter + +Choose Python 3 (ipykernal) + +5. Choose one of the .ipynb files + +## Using Jupyter + +* Individual code blocks can be run with "Shift + Enter". + +* You can pick a spot in the notebook and run all +the code up until that point. To do that, place your +cursor in the place you want the code to run to. Go +to the Run menu and choose "Run all above selected cell". + +Run to a code block + +* Text notes can be added by adding a cell and choosing "Markdown": + +Take notes + +* Code cells that have been run will have a number in the [ ]: + +Take notes + +* Export the notebook to a Python script: + +File -> Save and Export Notebook As -> Executable Script + + + + diff --git a/notebooks/images/jupyter_launch.png b/notebooks/images/jupyter_launch.png new file mode 100644 index 00000000..f4a80777 Binary files /dev/null and b/notebooks/images/jupyter_launch.png differ diff --git a/notebooks/images/run_to.png b/notebooks/images/run_to.png new file mode 100644 index 00000000..125fcbc0 Binary files /dev/null and b/notebooks/images/run_to.png differ diff --git a/notebooks/images/take_notes.png b/notebooks/images/take_notes.png new file mode 100644 index 00000000..9b475b1c Binary files /dev/null and b/notebooks/images/take_notes.png differ diff --git a/notebooks/images/was_run.png b/notebooks/images/was_run.png new file mode 100644 index 00000000..846c3e87 Binary files /dev/null and b/notebooks/images/was_run.png differ