Skip to content

Commit

Permalink
Merge pull request #126 from pryn-kb/main
Browse files Browse the repository at this point in the history
nothing really
  • Loading branch information
pryn-kb authored Aug 30, 2024
2 parents 83e206e + f147d22 commit b3b29d0
Show file tree
Hide file tree
Showing 19 changed files with 1,182 additions and 41 deletions.
Binary file modified .DS_Store
Binary file not shown.
Binary file added _build/.doctrees/docs/howto/jupyterlab.doctree
Binary file not shown.
Binary file modified _build/.doctrees/docs/howto/setup.doctree
Binary file not shown.
Binary file modified _build/.doctrees/docs/intro.doctree
Binary file not shown.
Binary file modified _build/.doctrees/environment.pickle
Binary file not shown.
188 changes: 188 additions & 0 deletions _build/html/_sources/docs/howto/jupyterlab.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "3c403798-1edc-4a2a-8bb4-c2fdc8d0497b",
"metadata": {},
"source": [
"# Guide to Opening and Navigating JupyterLab"
]
},
{
"cell_type": "markdown",
"id": "3d26a938-0498-4aff-9ba1-74d7390544e7",
"metadata": {},
"source": [
"___"
]
},
{
"cell_type": "markdown",
"id": "5c4fc7ab-d977-46b0-8ac2-8a6e4b2cef78",
"metadata": {},
"source": [
"## <i class=\"fab fa-apple\" aria-hidden=\"true\"></i> For macOS Users\n",
"\n",
"### Step 1: Open JupyterLab\n",
"\n",
"1. **Using Terminal**:\n",
" - **Open Terminal**:\n",
" - You can find Terminal by using Spotlight Search (press `Cmd + Space` and type \"Terminal\") or by navigating to `Applications` > `Utilities` > `Terminal`.\n",
"\n",
" - **Navigate to Your Project Directory** (Optional):\n",
" - If you want to start JupyterLab in a specific directory, use the `cd` command to navigate there. For example:\n",
" ```bash\n",
" cd path/to/your/project\n",
" ```\n",
" - If you're unsure of the path, you can drag the folder directly into the Terminal window, and it will automatically input the correct path.\n",
"\n",
"2. **Using Finder** (Alternative Method):\n",
" - **Open the Desired Folder in Finder**:\n",
" - Navigate to the folder where you want to start JupyterLab.\n",
"\n",
" - **Open Terminal from Finder**:\n",
" - Right-click on the folder while holding the `Control` key (or use a two-finger tap on a trackpad) and select **\"New Terminal at Folder\"**.\n",
" - If you don’t see this option, you might need to enable the \"New Terminal at Folder\" service. To do this:\n",
" - Go to `System Preferences` > `Keyboard` > `Shortcuts` > `Services`.\n",
" - Check the box next to \"New Terminal at Folder\" under the \"Files and Folders\" section.\n",
"\n",
"3. **Start JupyterLab**:\n",
" - In Terminal, type the following command and press `Enter`:\n",
" ```bash\n",
" jupyter lab\n",
" ```\n",
" - JupyterLab will open in your default web browser. If it doesn’t, copy the URL provided in the Terminal and paste it into your browser.\n",
"\n",
"### Step 2: Navigate the File/Directory System\n",
"\n",
"1. **File Browser**:\n",
" - On the left sidebar of JupyterLab, you’ll see the **File Browser**. This shows the directory contents of the folder where JupyterLab was started.\n",
" - You can open folders by clicking on them. Files (e.g., notebooks, Python scripts) can be opened by clicking on them.\n",
"\n",
"2. **Create New Files and Folders**:\n",
" - To create a new file or folder, right-click anywhere in the File Browser and select **New Folder** or **New File**. You can also click the `+` icon at the top of the File Browser.\n",
"\n",
"3. **Upload Files**:\n",
" - You can drag and drop files from your Finder directly into the File Browser in JupyterLab.\n",
"\n",
"4. **Navigate Between Folders**:\n",
" - Use the arrows next to folders to expand and collapse them.\n",
" - You can also use the breadcrumbs at the top of the File Browser to navigate back to parent directories.\n"
]
},
{
"cell_type": "markdown",
"id": "c9a091b6-c1d4-49a2-a40d-5be8f6a6599c",
"metadata": {},
"source": [
"___"
]
},
{
"cell_type": "markdown",
"id": "e84b576a-9d42-4447-9da5-6fd18722fd03",
"metadata": {},
"source": [
"## <i class=\"fab fa-windows\" aria-hidden=\"true\"></i> For Windows Users\n",
"\n",
"### Step 1: Open JupyterLab\n",
"\n",
"1. **Using Command Prompt**:\n",
" - **Open Command Prompt**:\n",
" - You can find it by searching \"cmd\" in the Start menu.\n",
"\n",
" - **Navigate to Your Project Directory** (Optional):\n",
" - Use the `cd` command to navigate to your desired directory. For example:\n",
" ```bash\n",
" cd C:\\path\\to\\your\\project\n",
" ```\n",
"\n",
"2. **Using File Explorer** (Alternative Method):\n",
" - **Open the Desired Folder in File Explorer**:\n",
" - Navigate to the folder where you want to start JupyterLab.\n",
"\n",
" - **Open Command Prompt from File Explorer**:\n",
" - Right-click on the folder while holding the `Shift` key and select **\"Open command window here\"** or **\"Open PowerShell window here\"**. This depends on your Windows version.\n",
" - On newer versions of Windows 10 and 11, this option might be replaced with **\"Open in Terminal\"**.\n",
"\n",
"3. **Start JupyterLab**:\n",
" - In the Command Prompt, PowerShell, or Terminal window that opens, type the following command and press `Enter`:\n",
" ```bash\n",
" jupyter lab\n",
" ```\n",
" - JupyterLab will open in your default web browser. If it doesn’t, copy the URL provided in the command prompt and paste it into your browser.\n",
"\n",
"### Step 2: Navigate the File/Directory System\n",
"\n",
"1. **File Browser**:\n",
" - On the left sidebar of JupyterLab, you’ll see the **File Browser**. This displays the contents of the directory where JupyterLab was started.\n",
" - Click on folders to open them and view their contents. Click on files (e.g., notebooks, Python scripts) to open them in JupyterLab.\n",
"\n",
"2. **Create New Files and Folders**:\n",
" - Right-click in the File Browser to create a new file or folder. Alternatively, click the `+` icon at the top of the File Browser.\n",
"\n",
"3. **Upload Files**:\n",
" - Drag and drop files from File Explorer directly into the JupyterLab File Browser.\n",
"\n",
"4. **Navigate Between Folders**:\n",
" - Use the arrows next to folders to expand and collapse them.\n",
" - The breadcrumbs at the top of the File Browser allow you to navigate back to parent directories."
]
},
{
"cell_type": "markdown",
"id": "077434d2-b4c0-404c-bf17-cd687a8fee41",
"metadata": {},
"source": [
"___"
]
},
{
"cell_type": "markdown",
"id": "030487df-aa1b-4ebf-99c8-780e92d1d4a2",
"metadata": {},
"source": [
"## <i class=\"fab fa-apple\" aria-hidden=\"true\"></i> <i class=\"fab fa-windows\" aria-hidden=\"true\"></i> Common Tips for Both macOS and Windows Users\n",
"\n",
"- **Opening Files**: Double-click on any file in the File Browser to open it. Jupyter Notebooks will open in a new tab, and text files, Python scripts, and other file types will open in their respective editors.\n",
" \n",
"- **Renaming Files and Folders**: Right-click on a file or folder in the File Browser and select \"Rename\" to change its name.\n",
"\n",
"- **Running Code Cells in Notebooks**: Inside a Jupyter Notebook, click inside a code cell and press `Shift + Enter` to execute the code in that cell.\n",
"\n",
"- **Terminal in JupyterLab**: You can open a Terminal within JupyterLab by clicking on the terminal icon in the Launcher (the tab with the `+` icon). This can be useful for running additional commands directly from within JupyterLab.\n",
"\n",
"- **Shutting Down JupyterLab**: To stop the JupyterLab server, go back to your Terminal, Command Prompt, or PowerShell window where JupyterLab was started, and press `Ctrl + C`. Confirm the shutdown if prompted."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "d714cc30-473f-4d75-a7b1-fefbacf2d06b",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.5"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
14 changes: 7 additions & 7 deletions _build/html/_sources/docs/howto/setup.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"tags": []
},
"source": [
"Before you can run, you must first walk (or slither).\n",
"Before you can run, you must first walk (or slither). <i class=\"fab fa-python\" aria-hidden=\"true\" style=\"font-size: 50px;\"></i>\n",
"\n",
"In order to get Python to run on your machine, you need to either download it directly or run it through an intermediary. There are many different ways to do this. \n",
"\n",
Expand Down Expand Up @@ -94,7 +94,7 @@
"tags": []
},
"source": [
"## Method 1: Installing Python and Jupyter Lab"
"## Method 1: Installing Python and JupyterLab"
]
},
{
Expand All @@ -108,7 +108,7 @@
"tags": []
},
"source": [
"The first of the three options we would like to highlight is installing Python and Jupyter Lab / Jupyter Notebook. This installs the software directly on to your computer. \n",
"The first of the three options we would like to highlight is installing Python and JupyterLab / Jupyter Notebook. This installs the software directly on to your computer. \n",
"\n",
"It is slightly technical, as you will have to initiate the program through your computer’s Terminal/PowerShell, but once running it is far less finicky than the other options with respect to uploading or downloading files that you might use in your coding. A detailed set of instructions for both Mac and PC users can be found on this page. "
]
Expand Down Expand Up @@ -829,7 +829,7 @@
"tags": []
},
"source": [
"### <i class=\"fab fa-apple\" aria-hidden=\"true\"></i> <i class=\"fab fa-windows\" aria-hidden=\"true\"></i> Jupyter Lab - both Mac and Windows"
"### <i class=\"fab fa-apple\" aria-hidden=\"true\"></i> <i class=\"fab fa-windows\" aria-hidden=\"true\"></i> JupyterLab - both Mac and Windows"
]
},
{
Expand All @@ -843,7 +843,7 @@
"tags": []
},
"source": [
"Now you need to install Jupyter Lab, the Integrated development environment (IDE) we will be using in this course. \n",
"Now you need to install JupyterLab, the Integrated development environment (IDE) we will be using in this course. \n",
"\n",
"We will install this from the Terminal (Mac) or PowerShell (Windows) using pip. \n",
"\n",
Expand Down Expand Up @@ -883,7 +883,7 @@
"```\n",
"This command will install pip. Afterwards, you can check by running the `pip3 --version` command.\n",
"\n",
"Now you can return to the installation of Jupyter Lab through pip.\n",
"Now you can return to the installation of JupyterLab through pip.\n",
"````"
]
},
Expand Down Expand Up @@ -1122,7 +1122,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.5"
"version": "3.12.5"
}
},
"nbformat": 4,
Expand Down
19 changes: 19 additions & 0 deletions _build/html/_static/custom.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
/**
* This script automatically makes external links on a webpage open in a new tab.
*
* It adds an event listener for the 'DOMContentLoaded' event, which ensures that
* the script runs only after the entire HTML document has been fully loaded and parsed.
*
* The script works as follows:
* 1. Select all anchor (`<a>`) tags on the page that have an `href` attribute.
* 2. For each link, the script creates a `URL` object based on the `href` attribute
* and compares the link's origin (protocol + domain) with the current page's origin.
* 3. If the origin of the link differs from the current page's origin, it indicates
* that the link is external.
* 4. The script then sets the `target` attribute of the link to `_blank`, which
* instructs the browser to open the link in a new tab.
*
* Compatibility: The script is compatible with modern browsers that support the
* `URL` constructor and `forEach` method.
*/

document.addEventListener("DOMContentLoaded", function() {
// Select all anchor tags with href attributes
const links = document.querySelectorAll('a[href]');
Expand Down
Loading

0 comments on commit b3b29d0

Please sign in to comment.