Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

re-organize install instructions #664

Merged
merged 30 commits into from
Jun 26, 2020
Merged

re-organize install instructions #664

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ab2c407
re-organize install instructions
fmichonneau May 29, 2020
1bfcbcd
fix mix up
fmichonneau Jun 1, 2020
0fb1b22
remove unused file
fmichonneau Jun 2, 2020
e48d359
update git for windows instructions
zkamvar Jun 9, 2020
e4cc19e
update online link to use page.address
zkamvar May 29, 2020
37caf47
protect example jekyll variables
zkamvar May 29, 2020
455d61d
Adding adblocker warning
sstevens2 Jun 2, 2020
e7859de
add link to role description
fmichonneau Jun 16, 2020
d3f6543
typo in online instruction location
lachlandeer Jun 16, 2020
4c67ce7
fix formatting for flavor warning notice
fmichonneau Jun 17, 2020
9e03f1f
add indication to check variables in curriculum warning
fmichonneau Jun 17, 2020
d92671c
display install instructions even if SWC curriculum is invalid
fmichonneau Jun 17, 2020
3439c73
incorporate @maxim-belkin comments
fmichonneau Jun 17, 2020
160bfea
update documentation for setup instructions
fmichonneau Jun 17, 2020
6e461d4
use FIXME as default value for `flavor`
fmichonneau Jun 17, 2020
1aa8f3d
add table of contents in customization page
fmichonneau Jun 17, 2020
c3bb0d1
edit and formatting
fmichonneau Jun 17, 2020
9e05fb2
remove unecessary comments and small edits
fmichonneau Jun 18, 2020
097153e
clarify that the tools aren't used often in carpentries workshops
fmichonneau Jun 19, 2020
cc7a479
use jekyll formatting for code blocks
fmichonneau Jun 19, 2020
592b0d0
add warning for invalid SWC curricula
fmichonneau Jun 23, 2020
a94c9f9
remove active class from tabpanels
fmichonneau Jun 26, 2020
2b194ba
remove unused/unecessary GA
fmichonneau Jun 26, 2020
9ce182f
consolidate javascript scripts in a single file
fmichonneau Jun 26, 2020
2e47644
add scripts to hide warning, inform eventbrite missing
fmichonneau Jun 26, 2020
e48ccaa
bring changes
fmichonneau Jun 26, 2020
3aac518
Fix customizations
maxim-belkin Jun 26, 2020
1cb123c
Merge branch 'gh-pages' into install-instructions
fmichonneau Jun 26, 2020
9437238
remove empty line
fmichonneau Jun 26, 2020
a29112e
remove dangling missing tag
fmichonneau Jun 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,23 @@
# https://github.com/carpentries/training-template
carpentry: "swc"

# This option is currently only needed for Data Carpentry workshops.
# The value of the variable will be ignored for Software Carpentry and
# Library Carpentry workshops.
# This option is currently only needed for
# Data Carpentry and Software Carpentry workshops.
# The value of the variable will be ignored for Library Carpentry
# workshops.
# Possible values are:
# dc-ecology: for Data Carpentry Ecology workshops
# dc-genomics: for Data Carpentry Genomics
# dc-socsci: for Data Carpentry Social Sciences
# dc-geospatial: for Data Carpentry Geospatial
# swc-inflammation: for Software Carpentry based on the inflammation dataset
# swc-gapminder: for Software Carpentry based on the Gapminder dataset
curriculum: "FIXME"

# If there is both an R and python official version of a curriculum, change the
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
# value of the variable below ("flavor") to get the schedule updated accordingly
# (valid values are 'r' or 'python').
# Note: this is only for Data Carpentry curricula at this time.
# value of the variable below ("flavor") to get the schedule and installation
# instructions updated accordingly (valid values are 'r' or 'python').
# Note: this is only for Data Carpentry and SWC at this time.
flavor: "r"

# Overall title for the Workshop.
Expand Down
66 changes: 66 additions & 0 deletions _includes/install_instructions/editor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@


<div id="editor"> {% comment %} Start of 'editor' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<h3>Text Editor</h3>

<p>
When you're writing code, it's nice to have a text editor that is
optimized for writing code, with features like automatic
color-coding of key words. The default text editor on macOS and
Linux is usually set to Vim, which is not famous for being
intuitive. If you accidentally find yourself stuck in it, hit
the <kbd>Esc</kbd> key, followed by <kbd>:</kbd>+<kbd>Q</kbd>+<kbd>!</kbd>
(colon, lower-case 'q', exclamation mark), then hitting <kbd>Return</kbd> to
return to the shell.
</p>

<div>
<ul class="nav nav-tabs nav-justified" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#editor-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#editor-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#editor-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="editor-windows">
<p>
nano is a basic editor and the default that instructors use in the workshop.
It is installed along with Git.
</p>
<p>
Others editors that you can use are
<a href="https://notepad-plus-plus.org/">Notepad++</a> or
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://www.sublimetext.com/">Sublime Text</a>.
<strong>Be aware that you must
add its installation directory to your system path.</strong>
Please ask your instructor to help you do this.
</p>
</article>
<article role="tabpanel" class="tab-pane active" id="editor-macos">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>
nano is a basic editor and the default that instructors use in the workshop.
See the Git installation <a href="https://www.youtube.com/watch?v=9LQhwETCdwY ">video tutorial</a>
for an example on how to open nano.
It should be pre-installed.
</p>
<p>
Others editors that you can use are
<a href="https://www.barebones.com/products/bbedit/">BBEdit</a> or
<a href="https://www.sublimetext.com/">Sublime Text</a>.
</p>
</article>
<article role="tabpanel" class="tab-pane active" id="editor-linux">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>
nano is a basic editor and the default that instructors use in the workshop.
It should be pre-installed.
</p>
<p>
Others editors that you can use are
<a href="https://wiki.gnome.org/Apps/Gedit">Gedit</a>,
<a href="https://kate-editor.org/">Kate</a> or
<a href="https://www.sublimetext.com/">Sublime Text</a>.
</p>
</article>
</div>
</div>
</div> {% comment %} End of 'editor' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
63 changes: 63 additions & 0 deletions _includes/install_instructions/git.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@

<div id="git"> {% comment %} Start of 'Git' section. GitHub browser compatibility
is given at https://help.github.com/articles/supported-browsers/{% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<h3>Git</h3>
<p>
Git is a version control system that lets you track who made changes
to what when and has options for easily updating a shared or public
version of your code
on <a href="https://github.com/">github.com</a>. You will need a
<a href="https://help.github.com/articles/supported-browsers/">supported
web browser</a>.
</p>
<p>
You will need an account at <a href="https://github.com/">github.com</a>
for parts of the Git lesson. Basic GitHub accounts are free. We encourage
you to create a GitHub account if you don't have one already.
Please consider what personal information you'd like to reveal. For
example, you may want to review these
<a href="https://help.github.com/articles/keeping-your-email-address-private/">instructions
for keeping your email address private</a> provided at GitHub.
</p>

<div>
<ul class="nav nav-tabs nav-justified" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#git-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#git-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#git-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="git-windows">
<p>
Git should be installed on your computer as part of your Bash
install (described above).
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
</p>
</article>
<article role="tabpanel" class="tab-pane active" id="git-macos">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://www.youtube.com/watch?v=9LQhwETCdwY ">Video Tutorial</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can embed these videos....

<p>
<strong>For OS X 10.9 and higher</strong>, install Git for Mac
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OS X -> macOS
"10.9 or higher" is too vague because 10.9 was released in 2013. I believe that in recent macOS versions one has to install Command Line Tools (the process for doing that differs on different versions of macOS)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the OS X references but also now realizes that the recommended git osx installer hasn't been updated in over a year and I'm wondering if it's still the best recommendation for workshop participants 🤔

by downloading and running the most recent "mavericks" installer from
<a href="http://sourceforge.net/projects/git-osx-installer/files/">this list</a>.
Because this installer is not signed by the developer, you may have to
right click (control click) on the .pkg file, click Open, and click
Open on the pop up window.
After installing Git, there will not be anything in your <code>/Applications</code> folder,
as Git is a command line program.
<strong>For older versions of OS X (10.5-10.8)</strong> use the
most recent available installer labelled "snow-leopard"
<a href="http://sourceforge.net/projects/git-osx-installer/files/">available here</a>.
</p>
</article>
<article role="tabpanel" class="tab-pane active" id="git-linux">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>
If Git is not already available on your machine you can try to
install it via your distro's package manager. For Debian/Ubuntu run
<code>sudo apt-get install git</code> and for Fedora run
<code>sudo dnf install git</code>.
</p>
</article>
</div>
</div>
</div> {% comment %} End of 'Git' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
51 changes: 51 additions & 0 deletions _includes/install_instructions/openrefine.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<div id="openrefine"> {% comment %} Start of 'OpenRefine' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<h3>OpenRefine</h3>
<p>
For this lesson you will need <em>OpenRefine</em> and a
web browser. <em>Note:</em> this is a Java program that runs on your machine (not in the cloud).
It runs inside a web browser, but no web connection is needed.
</p>

<div>
<ul class="nav nav-tabs nav-justified" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#openrefine-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#openrefine-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#openrefine-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="openrefine-windows">
<p>
Check that you have either the Firefox or the Chrome browser installed and set as your default browser.
<strong>OpenRefine runs in your default browser.</strong>
It will not run correctly in Internet Explorer.
</p>
<p>Download software from <a href="http://openrefine.org/">http://openrefine.org/</a></p>
<p>Create a new directory called OpenRefine.</p>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>Unzip the downloaded file into the OpenRefine directory by right-clicking and selecting "Extract ...". </p>
<p>Go to your newly created OpenRefine directory.</p>
<p>Launch OpenRefine by clicking <code>openrefine.exe</code> (this will launch a command prompt window, but you can ignore that - just wait for OpenRefine to open in the browser).</p>
<p>If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at <a href="http://127.0.0.1:3333/">http://127.0.0.1:3333/</a> or <a href="http://localhost:3333">http://localhost:3333</a> to use the program.</p>
</article>
<article role="tabpanel" class="tab-pane active" id="openrefine-macos">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>Check that you have either the Firefox or the Chrome browser installed and set as your default browser. <strong>OpenRefine runs in your default browser.</strong> It may not run correctly in Safari.</p>
<p>Download software from <a href="http://openrefine.org/">http://openrefine.org/</a>.</p>
<p>Create a new directory called OpenRefine.</p>
<p>Unzip the downloaded file into the OpenRefine directory by double-clicking it.</p>
<p>Go to your newly created OpenRefine directory.</p>
<p>Launch OpenRefine by dragging the icon into the Applications folder.</p>
<p>Use <code>Ctrl-click/Open ... </code> to launch it.</p>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at <a href="http://127.0.0.1:3333/">http://127.0.0.1:3333/</a> or <a href="http://localhost:3333">http://localhost:3333</a> to use the program.</p>
</article>
<article role="tabpanel" class="tab-pane active" id="openrefine-linux">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>Check that you have either the Firefox or the Chrome browser installed and set as your default browser. <strong>OpenRefine runs in your default browser.</strong></p>
<p>Download software from <a href="http://openrefine.org/">http://openrefine.org/</a>.</p>
<p>Make a directory called OpenRefine.</p>
<p>Unzip the downloaded file into the OpenRefine directory.</p>
<p>Go to your newly created OpenRefine directory.</p>
<p>Launch OpenRefine by entering <code>./refine</code> into the terminal within the OpenRefine directory.</p>
<p>If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at <a href="http://127.0.0.1:3333/">http://127.0.0.1:3333/</a> or <a href="http://localhost:3333">http://localhost:3333</a> to use the program.</p>
</article>
</div>
</div>
</div> {% comment %} End of 'OpenRefine' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
98 changes: 98 additions & 0 deletions _includes/install_instructions/python.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<div id="python"> {% comment %} Start of 'Python' section. Remove the third paragraph if
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
the workshop will teach Python using something other than
the Jupyter Notebook.
Details at https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#browser-compatibility {% endcomment %}
<h3>Python</h3>

<p>
<a href="https://python.org">Python</a> is a popular language for
research computing, and great for general-purpose programming as
well. Installing all of its research packages individually can be
a bit difficult, so we recommend
<a href="https://www.anaconda.com/distribution/">Anaconda</a>,
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
an all-in-one installer.
</p>

<p>
Regardless of how you choose to install it,
<strong>please make sure you install Python version 3.x</strong>
(e.g., 3.6 is fine).
</p>

<p>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
We will teach Python using the <a href="https://jupyter.org/">Jupyter Notebook</a>,
a programming environment that runs in a web browser (Jupyter Notebook will be installed by Anaconda). For this to work you will need a reasonably
up-to-date browser. The current versions of the Chrome, Safari and
Firefox browsers are all
<a href="https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#browser-compatibility">supported</a>
(some older browsers, including Internet Explorer version 9
and below, are not).
</p>

<div>
<ul class="nav nav-tabs nav-justified" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#python-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#python-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#python-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="python-windows">
<a href="https://www.youtube.com/watch?v=xxQ0mzZ8UvA">Video Tutorial</a>
<ol>
<li>Open <a href="https://www.anaconda.com/distribution/#download-section">https://www.anaconda.com/distribution/#download-section</a> with your web browser.</li>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<li>Download the Anaconda for Windows installer with Python 3. (If you are not sure which version to choose, you probably want the 64-bit Graphical Installer <em>Anaconda3-...-Windows-x86_64.exe</em>)</li>
<li>Install Python 3 by running the Anaconda Installer, using all of the defaults for installation <em>except</em> make sure to check <strong>Add Anaconda to my PATH environment variable</strong>.</li>
</ol>
</article>
<article role="tabpanel" class="tab-pane active" id="python-macos">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://www.youtube.com/watch?v=TcSAln46u9U">Video Tutorial</a>
<ol>
<li>Open <a href="https://www.anaconda.com/distribution/#download-section">https://www.anaconda.com/distribution/#download-section</a> with your web browser.</li>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<li>Download the Anaconda Installer with Python 3 for macOS (you can either use the Graphical or the Command Line Installer).</li>
<li>Install Python 3 by running the Anaconda Installer using all of the defaults for installation.</li>
</ol>
</article>
<article role="tabpanel" class="tab-pane active" id="python-linux">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<ol>
<li>Open <a href="https://www.anaconda.com/distribution/#download-section">https://www.anaconda.com/distribution/#download-section</a> with your web browser.</li>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<li>Download the Anaconda Installer with Python 3 for Linux.<br>
(The installation requires using the shell. If you aren't
comfortable doing the installation yourself
stop here and request help at the workshop.)
</li>
<li>
Open a terminal window and navigate to the directory where
the executable is downloaded (e.g., `cd ~/Downloads`).
</li>
<li>
Type <pre>bash Anaconda3-</pre> and then press
<kbd>Tab</kbd> to autocomplete the full file name. The name of
file you just downloaded should appear.
</li>
<li>
Press <kbd>Enter</kbd>.
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
You will follow the text-only prompts.
To move through the text, press <kbd>Spacebar</kbd>.
Type <code>yes</code> and press enter to approve the license.
Press <kbd>Enter</kbd> to approve the default location
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
for the files.
Type <code>yes</code> and press <kbd>Enter</kbd>
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
to prepend Anaconda to your <code>PATH</code>
(this makes the Anaconda distribution the default Python).
</li>
<li>
Close the terminal window.
</li>
</ol>
</article>
</div>
</div>
{% comment %}
<p>
Once you are done installing the software listed above,
please go to <a href="setup/index.html">this page</a>,
which has instructions on how to test that everything was installed correctly.
</p>
{% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
</div> {% comment %} End of 'Python' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
55 changes: 55 additions & 0 deletions _includes/install_instructions/r.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<div id="r"> {% comment %} Start of 'R' section. {% endcomment %}
<h3>R</h3>

<p>
<a href="https://www.r-project.org">R</a> is a programming language
that is especially powerful for data exploration, visualization, and
statistical analysis. To interact with R, we use
<a href="https://www.rstudio.com/">RStudio</a>.
</p>

<div>
<ul class="nav nav-tabs nav-justified" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#rstats-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#rstats-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#rstats-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="rstats-windows">
<a href="https://www.youtube.com/watch?v=q0PjTAylwoU">Video Tutorial</a>
<p>
Install R by downloading and running
<a href="https://cran.r-project.org/bin/windows/base/release.htm">this .exe file</a>
from <a href="https://cran.r-project.org/index.html">CRAN</a>.
Also, please install the
<a href="https://www.rstudio.com/products/rstudio/download/#download">RStudio IDE</a>.
Note that if you have separate user and admin accounts, you should run the
installers as administrator (right-click on .exe file and select "Run as
administrator" instead of double-clicking). Otherwise problems may occur later,
for example when installing R packages.
</p>
</article>
<article role="tabpanel" class="tab-pane active" id="rstats-macos">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://www.youtube.com/watch?v=5-ly3kyxwEg">Video Tutorial</a>
<p>
Install R by downloading and running
<a href="https://cran.r-project.org/bin/macosx/R-latest.pkg">this .pkg file</a>
from <a href="https://cran.r-project.org/index.html">CRAN</a>.
Also, please install the
<a href="https://www.rstudio.com/products/rstudio/download/#download">RStudio IDE</a>.
</p>
</article>
<article role="tabpanel" class="tab-pane active" id="rstats-linux">
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
<p>
You can download the binary files for your distribution
from <a href="https://cran.r-project.org/index.html">CRAN</a>. Or
you can use your package manager (e.g. for Debian/Ubuntu
run <code>sudo apt-get install r-base</code> and for Fedora run
<code>sudo dnf install R</code>). Also, please install the
<a href="https://www.rstudio.com/products/rstudio/download/#download">RStudio IDE</a>.
</p>
</article>
</div>
</div>
</div> {% comment %} End of 'R' section. {% endcomment %}
fmichonneau marked this conversation as resolved.
Show resolved Hide resolved
Loading