new installation instructions for HNN GUI

jonescompneurolab · May 5, 2024 · ea04030 · ea04030
1 parent 056abf3
commit ea04030
Show file tree

Hide file tree

Showing 6 changed files with 324 additions and 0 deletions.
diff --git a/installation_instructions/linux/linux.html b/installation_instructions/linux/linux.html
@@ -0,0 +1,95 @@
+<!-- START -->
+<!-- html header, styling for Tutorials pages -->
+<!-- note: requires stylesheet.css to be in the parent directory; see <head> section -->
+<!-- copy the contents below into the appropriate sections of your html page -->
+
+<!-- document setup -->
+
+<html>
+
+<!-- head area -->
+<head>
+<!-- <meta charset="utf-8" /> --> <!-- old version -->
+<meta charset="utf-8" name="viewport" content="width=device-width, initial-scale=1.0" /> <!-- set the viewport https://www.w3schools.com/css/css_rwd_viewport.asp -->
+<title>Tutorials - HNN</title>
+<!-- import CSS style sheet from Github directory -->
+<link rel = "stylesheet" type = "text/css" href = "../../html-styling/stylesheet.css" />
+</head>
+
+<!-- body styling -->
+<body>
+
+<!-- add Navbar -->
+<div class="navbar">
+  <div id="wrapper">
+    <img src="https://hnn.brown.edu/wp-content/uploads/2018/05/mainlogo3.png" alt="HNN" scale="0">
+    <a href="https://hnn.brown.edu/index.php/tutorials/#jumptutorials">TUTORIALS</a>
+    <a href="https://hnn.brown.edu">HOME</a>
+  </div>
+</div>
+
+<!-- add Tutorials header -->
+<div class="headercontainer main">
+<div class="headertext">  </div>
+</div>
+
+<!-- set width for body to 900px -->
+<div id="wrapper">
+
+<!-- add button to scroll to top -->
+<button onclick="topFunction()" id="myBtn" title="Scroll to top">Top</button>
+
+<!-- script for scroll button function -->
+<script>
+//Get the button:
+mybutton = document.getElementById("myBtn");
+// When the user scrolls down 20px from the top of the document, show the button
+window.onscroll = function() {scrollFunction()};
+function scrollFunction() {
+  if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
+    mybutton.style.display = "block";
+  } else {
+    mybutton.style.display = "none";
+  }
+}
+// When the user clicks on the button, scroll to the top of the document
+function topFunction() {
+  document.body.scrollTop = 0; // For Safari
+  document.documentElement.scrollTop = 0; // For Chrome, Firefox, IE and Opera
+}
+</script>
+
+<!-- return to tutorials page -->
+<div style="text-align:center; vertical-align: middle; padding:10px;">
+<p></p>
+
+<tbody>
+<tr style="border: none;">
+<td style="border: none; width: 33.3%; padding: 1px;">
+</td>
+
+<td style="border: none; width: 33.3%; padding: 1px;">
+<!--<a style="text-decoration: none" href="https://hnn.brown.edu/index.php/tutorials/">-->
+<p><img src="https://hnn.brown.edu/wp-content/uploads/2019/06/EEG_Brain.png" width="60" height="auto"></p>
+<p style=" font-family: sans-serif; font-size: x-large; font-weight:700; color: #1156a3; border:0px; margin:0px;">Tutorials</p>
+<!--</a>-->
+</td>
+
+<td style="border: none; width: 33.3%; padding: 1px;">
+</td>
+</tr>
+</tbody>
+</div>
+
+<!-- your contents go here -->
+
+<!-- </body> -->
+<!-- </html> -->
+<!-- END -->
+<h1 id="linux-installation-instructions">Linux Installation Instructions</h1>
+<h2 id="recommended-method-docker-installation">Recommended Method: Docker Installation</h2>
+<p>We recommend the Docker installation method for Linux.</p>
+<p>Updated installation instructions for HNN GUI are currently being developed. Thank you for your patience while we work to bring you an easier installation process.</p>
+<p>In the meantime, please see the following <a href="https://github.com/jonescompneurolab/hnn/pull/337">GitHub page</a> which outlines the essential components of the Docker installation method</p>
+<h2 id="advanced-users-local-installation">Advanced Users: Local Installation</h2>
+<p>Intructions for local installation can be found <a href="https://jonescompneurolab.github.io/hnn/installer/ubuntu/">here</a></p>
diff --git a/installation_instructions/linux/linux.md b/installation_instructions/linux/linux.md
@@ -0,0 +1,13 @@
+# Linux Installation Instructions
+
+## Recommended Method: Docker Installation
+
+We recommend the Docker installation method for Linux. 
+
+Updated installation instructions for HNN GUI are currently being developed. Thank you for your patience while we work to bring you an easier installation process.
+
+In the meantime, please see the following <a href="https://github.com/jonescompneurolab/hnn/pull/337">GitHub page</a> which outlines the essential components of the Docker installation method
+
+## Advanced Users: Local Installation
+
+Intructions for local installation can be found <a href="https://jonescompneurolab.github.io/hnn/installer/ubuntu/">here</a>
diff --git a/installation_instructions/macos/macos.html b/installation_instructions/macos/macos.html
@@ -0,0 +1,95 @@
+<!-- START -->
+<!-- html header, styling for Tutorials pages -->
+<!-- note: requires stylesheet.css to be in the parent directory; see <head> section -->
+<!-- copy the contents below into the appropriate sections of your html page -->
+
+<!-- document setup -->
+
+<html>
+
+<!-- head area -->
+<head>
+<!-- <meta charset="utf-8" /> --> <!-- old version -->
+<meta charset="utf-8" name="viewport" content="width=device-width, initial-scale=1.0" /> <!-- set the viewport https://www.w3schools.com/css/css_rwd_viewport.asp -->
+<title>Tutorials - HNN</title>
+<!-- import CSS style sheet from Github directory -->
+<link rel = "stylesheet" type = "text/css" href = "../../html-styling/stylesheet.css" />
+</head>
+
+<!-- body styling -->
+<body>
+
+<!-- add Navbar -->
+<div class="navbar">
+  <div id="wrapper">
+    <img src="https://hnn.brown.edu/wp-content/uploads/2018/05/mainlogo3.png" alt="HNN" scale="0">
+    <a href="https://hnn.brown.edu/index.php/tutorials/#jumptutorials">TUTORIALS</a>
+    <a href="https://hnn.brown.edu">HOME</a>
+  </div>
+</div>
+
+<!-- add Tutorials header -->
+<div class="headercontainer main">
+<div class="headertext">  </div>
+</div>
+
+<!-- set width for body to 900px -->
+<div id="wrapper">
+
+<!-- add button to scroll to top -->
+<button onclick="topFunction()" id="myBtn" title="Scroll to top">Top</button>
+
+<!-- script for scroll button function -->
+<script>
+//Get the button:
+mybutton = document.getElementById("myBtn");
+// When the user scrolls down 20px from the top of the document, show the button
+window.onscroll = function() {scrollFunction()};
+function scrollFunction() {
+  if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
+    mybutton.style.display = "block";
+  } else {
+    mybutton.style.display = "none";
+  }
+}
+// When the user clicks on the button, scroll to the top of the document
+function topFunction() {
+  document.body.scrollTop = 0; // For Safari
+  document.documentElement.scrollTop = 0; // For Chrome, Firefox, IE and Opera
+}
+</script>
+
+<!-- return to tutorials page -->
+<div style="text-align:center; vertical-align: middle; padding:10px;">
+<p></p>
+
+<tbody>
+<tr style="border: none;">
+<td style="border: none; width: 33.3%; padding: 1px;">
+</td>
+
+<td style="border: none; width: 33.3%; padding: 1px;">
+<!--<a style="text-decoration: none" href="https://hnn.brown.edu/index.php/tutorials/">-->
+<p><img src="https://hnn.brown.edu/wp-content/uploads/2019/06/EEG_Brain.png" width="60" height="auto"></p>
+<p style=" font-family: sans-serif; font-size: x-large; font-weight:700; color: #1156a3; border:0px; margin:0px;">Tutorials</p>
+<!--</a>-->
+</td>
+
+<td style="border: none; width: 33.3%; padding: 1px;">
+</td>
+</tr>
+</tbody>
+</div>
+
+<!-- your contents go here -->
+
+<!-- </body> -->
+<!-- </html> -->
+<!-- END -->
+<h1 id="macos-installation-instructions">MacOS Installation Instructions</h1>
+<h2 id="recommended-method-docker-installation">Recommended Method: Docker Installation</h2>
+<p>We recommend the Docker installation method for Mac.</p>
+<p>Updated installation instructions for HNN GUI are currently being developed. Thank you for your patience while we work to bring you an easier installation process.</p>
+<p>In the meantime, please see the following <a href="https://github.com/jonescompneurolab/hnn/pull/337">GitHub page</a> which outlines the essential components of the Docker installation method for MacOS</p>
+<h2 id="advanced-users-local-installation">Advanced Users: Local Installation</h2>
+<p>Intructions for local installation can be found <a href="https://jonescompneurolab.github.io/hnn/installer/mac/">here</a></p>
diff --git a/installation_instructions/macos/macos.md b/installation_instructions/macos/macos.md
@@ -0,0 +1,13 @@
+# MacOS Installation Instructions
+
+## Recommended Method: Docker Installation
+
+We recommend the Docker installation method for Mac. 
+
+Updated installation instructions for HNN GUI are currently being developed. Thank you for your patience while we work to bring you an easier installation process.
+
+In the meantime, please see the following <a href="https://github.com/jonescompneurolab/hnn/pull/337">GitHub page</a> which outlines the essential components of the Docker installation method for MacOS
+
+## Advanced Users: Local Installation
+
+Intructions for local installation can be found <a href="https://jonescompneurolab.github.io/hnn/installer/mac/">here</a>
diff --git a/installation_instructions/windows/windows.html b/installation_instructions/windows/windows.html
@@ -0,0 +1,95 @@
+<!-- START -->
+<!-- html header, styling for Tutorials pages -->
+<!-- note: requires stylesheet.css to be in the parent directory; see <head> section -->
+<!-- copy the contents below into the appropriate sections of your html page -->
+
+<!-- document setup -->
+
+<html>
+
+<!-- head area -->
+<head>
+<!-- <meta charset="utf-8" /> --> <!-- old version -->
+<meta charset="utf-8" name="viewport" content="width=device-width, initial-scale=1.0" /> <!-- set the viewport https://www.w3schools.com/css/css_rwd_viewport.asp -->
+<title>Tutorials - HNN</title>
+<!-- import CSS style sheet from Github directory -->
+<link rel = "stylesheet" type = "text/css" href = "../../html-styling/stylesheet.css" />
+</head>
+
+<!-- body styling -->
+<body>
+
+<!-- add Navbar -->
+<div class="navbar">
+  <div id="wrapper">
+    <img src="https://hnn.brown.edu/wp-content/uploads/2018/05/mainlogo3.png" alt="HNN" scale="0">
+    <a href="https://hnn.brown.edu/index.php/tutorials/#jumptutorials">TUTORIALS</a>
+    <a href="https://hnn.brown.edu">HOME</a>
+  </div>
+</div>
+
+<!-- add Tutorials header -->
+<div class="headercontainer main">
+<div class="headertext">  </div>
+</div>
+
+<!-- set width for body to 900px -->
+<div id="wrapper">
+
+<!-- add button to scroll to top -->
+<button onclick="topFunction()" id="myBtn" title="Scroll to top">Top</button>
+
+<!-- script for scroll button function -->
+<script>
+//Get the button:
+mybutton = document.getElementById("myBtn");
+// When the user scrolls down 20px from the top of the document, show the button
+window.onscroll = function() {scrollFunction()};
+function scrollFunction() {
+  if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
+    mybutton.style.display = "block";
+  } else {
+    mybutton.style.display = "none";
+  }
+}
+// When the user clicks on the button, scroll to the top of the document
+function topFunction() {
+  document.body.scrollTop = 0; // For Safari
+  document.documentElement.scrollTop = 0; // For Chrome, Firefox, IE and Opera
+}
+</script>
+
+<!-- return to tutorials page -->
+<div style="text-align:center; vertical-align: middle; padding:10px;">
+<p></p>
+
+<tbody>
+<tr style="border: none;">
+<td style="border: none; width: 33.3%; padding: 1px;">
+</td>
+
+<td style="border: none; width: 33.3%; padding: 1px;">
+<!--<a style="text-decoration: none" href="https://hnn.brown.edu/index.php/tutorials/">-->
+<p><img src="https://hnn.brown.edu/wp-content/uploads/2019/06/EEG_Brain.png" width="60" height="auto"></p>
+<p style=" font-family: sans-serif; font-size: x-large; font-weight:700; color: #1156a3; border:0px; margin:0px;">Tutorials</p>
+<!--</a>-->
+</td>
+
+<td style="border: none; width: 33.3%; padding: 1px;">
+</td>
+</tr>
+</tbody>
+</div>
+
+<!-- your contents go here -->
+
+<!-- </body> -->
+<!-- </html> -->
+<!-- END -->
+<h1 id="windows-installation-instructions">Windows Installation Instructions</h1>
+<h2 id="recommended-method-docker-installation">Recommended Method: Docker Installation</h2>
+<p>We recommend the Docker installation method for Windows.</p>
+<p>Updated installation instructions for HNN GUI are currently being developed. Thank you for your patience while we work to bring you an easier installation process.</p>
+<p>In the meantime, please see the following <a href="https://github.com/jonescompneurolab/hnn/pull/337">GitHub page</a> which outlines the essential components of the Docker installation method on Windows</p>
+<h2 id="advanced-users-local-installation">Advanced Users: Local Installation</h2>
+<p>Intructions for local installation can be found <a href="https://jonescompneurolab.github.io/hnn/installer/windows/">here</a></p>
diff --git a/installation_instructions/windows/windows.md b/installation_instructions/windows/windows.md
@@ -0,0 +1,13 @@
+# Windows Installation Instructions
+
+## Recommended Method: Docker Installation
+
+We recommend the Docker installation method for Windows. 
+
+Updated installation instructions for HNN GUI are currently being developed. Thank you for your patience while we work to bring you an easier installation process.
+
+In the meantime, please see the following <a href="https://github.com/jonescompneurolab/hnn/pull/337">GitHub page</a> which outlines the essential components of the Docker installation method on Windows
+
+## Advanced Users: Local Installation
+
+Intructions for local installation can be found <a href="https://jonescompneurolab.github.io/hnn/installer/windows/">here</a>