Skip to content

Commit

Permalink
some reworks to the sections
Browse files Browse the repository at this point in the history
  • Loading branch information
dylansdaniels committed Aug 28, 2024
1 parent 0fe0ef2 commit 4107751
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 21 deletions.
25 changes: 13 additions & 12 deletions workshop-instructions/instructions.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,11 @@
<p><strong>Table of Contents</strong></p>
<ul>
<li><a href="#workshop-sign-in-optional-but-encouraged">Workshop Sign-In (Optional but Encouraged)</a></li>
<li><a href="#download-workshop-materials">Download Workshop Materials</a></li>
<li><a href="#workshop-materials">Workshop Materials</a>
<ul>
<li><a href="#hnn-core-gui-tutorial">HNN-Core GUI Tutorial</a></li>
<li><a href="#hnn-core-python-tutorial">HNN-Core Python Tutorial</a></li>
</ul></li>
<li><a href="#preferred-installation-method-google-colab">Preferred Installation Method: Google CoLab</a></li>
<li><a href="#alternative-installation-methods">Alternative Installation Methods</a>
<ul>
Expand All @@ -115,17 +119,14 @@ <h1 id="workshop-sign-in-optional-but-encouraged">Workshop Sign-In (Optional but
<p>
Thanks for your support. 😁
</p>
<h1 id="download-workshop-materials">Download Workshop Materials</h1>
<p>To follow along with the workshop, you’ll need to download the following materials:</p>
<ul>
<li>The <a href="https://github.com/jonescompneurolab/hnn-data">hnn-data repository</a> (needed for the HNN-Core GUI tutorial)</li>
<li>The <a href="https://github.com/jasmainak/hnn-workshop-materials/tree/biomag_2024">hnn-workshop-materials repository</a> (needed for the HNN-Core Python tutorial)</li>
</ul>
<p>Click <a href="https://github.com/jonescompneurolab/hnn-data/archive/refs/heads/main.zip">here</a> to download the hnn-data folder, and <a href="https://github.com/jasmainak/hnn-workshop-materials/archive/refs/heads/biomag_2024.zip">here</a> to download the hnn-workshop-materials folder.</p>
<p>Altenatively, you can clone the repositores with the follwing commands.</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1"></a><span class="fu">git</span> clone https://github.com/jonescompneurolab/hnn-data.git</span>
<span id="cb1-2"><a href="#cb1-2"></a><span class="fu">git</span> clone https://github.com/jasmainak/hnn-workshop-materials.git</span></code></pre></div>
<p>If you’ve already cloned the repositories in the past, be sure to run <code>git pull</code> to download the latest updates.</p>
<h1 id="workshop-materials">Workshop Materials</h1>
<h2 id="hnn-core-gui-tutorial">HNN-Core GUI Tutorial</h2>
<p>This section of the workshop will require you to use HNN-Core GUI. See the sections below outlining the different installation methods available for getting started with the GUI.</p>
<p>To follow along with the workshop, you’ll also need to clone or download the <a href="https://github.com/jonescompneurolab/hnn-data">hnn-data repository</a>.</p>
<p>Click <a href="https://github.com/jonescompneurolab/hnn-data/archive/refs/heads/main.zip">here</a> to download the hnn-data folder directly. Altenatively, you can clone the repository with the follwing command.</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1"></a><span class="fu">git</span> clone https://github.com/jonescompneurolab/hnn-data.git</span></code></pre></div>
<h2 id="hnn-core-python-tutorial">HNN-Core Python Tutorial</h2>
<p>The HNN-Core Python tutorial will utilize the following Google CoLab notebook, which can also be downloaded as an .ipynb file and run locally: <a href="https://colab.research.google.com/drive/1CvNTB_puonJiVvHmFhKhrr_CjmrfbgVB?usp=sharing">hnn-workshop-materials</a></p>
<h1 id="preferred-installation-method-google-colab">Preferred Installation Method: Google CoLab</h1>
<p>This installation method is the quickest way to get up and running with the HNN-Core GUI, though it does require a Google Account. If you do not have a Google account, you can either create one for free to run the notebook, or try one of the other installation methods listed below.</p>
<p>We have created a Google CoLab notebook that allows you to run the HNN-Core GUI out of your browser, with access to your local filesystem. Click <a href="https://colab.research.google.com/drive/1yyjuEBimIu_f7_0Nf3YLwUiVOO7ZrKK3?usp=sharing">here</a> to open the notebook, which includes instructions on how to get set up.</p>
Expand Down
21 changes: 12 additions & 9 deletions workshop-instructions/instructions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
**Table of Contents**

- [Workshop Sign-In (Optional but Encouraged)](#workshop-sign-in-optional-but-encouraged)
- [Download Workshop Materials](#download-workshop-materials)
- [Workshop Materials](#workshop-materials)
- [HNN-Core GUI Tutorial](#hnn-core-gui-tutorial)
- [HNN-Core Python Tutorial](#hnn-core-python-tutorial)
- [Preferred Installation Method: Google CoLab](#preferred-installation-method-google-colab)
- [Alternative Installation Methods](#alternative-installation-methods)
- [Oscar On Demand (OOD) Virtual Desktop](#oscar-on-demand-ood-virtual-desktop)
Expand All @@ -24,22 +26,23 @@ Click [here](https://forms.gle/YnZX9ZRm8WvWpAGU7) to navigate to our Virtual Sig
<p>Thanks for your support. &#128513;</p>


# Download Workshop Materials
To follow along with the workshop, you'll need to download the following materials:
# Workshop Materials

- The [hnn-data repository](https://github.com/jonescompneurolab/hnn-data) (needed for the HNN-Core GUI tutorial)
- The [hnn-workshop-materials repository](https://github.com/jasmainak/hnn-workshop-materials/tree/biomag_2024) (needed for the HNN-Core Python tutorial)
## HNN-Core GUI Tutorial

Click [here](https://github.com/jonescompneurolab/hnn-data/archive/refs/heads/main.zip) to download the hnn-data folder, and [here](https://github.com/jasmainak/hnn-workshop-materials/archive/refs/heads/biomag_2024.zip) to download the hnn-workshop-materials folder.
This section of the workshop will require you to use HNN-Core GUI. See the sections below outlining the different installation methods available for getting started with the GUI.

Altenatively, you can clone the repositores with the follwing commands.
To follow along with the workshop, you'll also need to clone or download the [hnn-data repository](https://github.com/jonescompneurolab/hnn-data).

Click [here](https://github.com/jonescompneurolab/hnn-data/archive/refs/heads/main.zip) to download the hnn-data folder directly. Altenatively, you can clone the repository with the follwing command.

```bash
git clone https://github.com/jonescompneurolab/hnn-data.git
git clone https://github.com/jasmainak/hnn-workshop-materials.git
```

If you've already cloned the repositories in the past, be sure to run `git pull` to download the latest updates.
## HNN-Core Python Tutorial

The HNN-Core Python tutorial will utilize the following Google CoLab notebook, which can also be downloaded as an .ipynb file and run locally: [hnn-workshop-materials](https://colab.research.google.com/drive/1CvNTB_puonJiVvHmFhKhrr_CjmrfbgVB?usp=sharing)

# Preferred Installation Method: Google CoLab

Expand Down

0 comments on commit 4107751

Please sign in to comment.