Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upAdds Notebook Learning Guide, Resolves #311 #313
+120
−9
Conversation
ianmilligan1
added some commits
Jul 2, 2019
ianmilligan1
requested review from
ruebot and
SamFritz
Jul 4, 2019
This comment has been minimized.
This comment has been minimized.
|
@ianmilligan1 double-check your tests https://travis-ci.org/archivesunleashed/auk/builds/554213847#L396-L399 |
This comment has been minimized.
This comment has been minimized.
codecov-io
commented
Jul 4, 2019
•
Codecov Report
@@ Coverage Diff @@
## master #313 +/- ##
=========================================
+ Coverage 89.33% 89.4% +0.06%
=========================================
Files 35 35
Lines 619 623 +4
=========================================
+ Hits 553 557 +4
Misses 66 66
Continue to review full report at Codecov.
|
ianmilligan1
changed the title
Adds Notebook Learning Guide
Adds Notebook Learning Guide, Resolves #311
Jul 4, 2019
ruebot
requested changes
Jul 4, 2019
|
Couple of small tweaks. There is also a few instances of double spaces after a full stop. |
| </div> | ||
| <br /> | ||
| <h3 class="about_h3" id="1toc">Introduction</h3> | ||
| <p class="about_p">The Archives Unleashed Cloud Notebooks require the use of Anaconda Distribution’s Jupyter Notebooks, as well as a working knowledge of the command line. For an introduction to the command line, see Ian Milligan and James Baker’s <%= link_to('Introduction to the Bash Command Line', 'https://programminghistorian.org/en/lessons/intro-to-bash', target: '_blank') %>.</p> |
This comment has been minimized.
This comment has been minimized.
ruebot
Jul 4, 2019
Member
The Archives Unleashed Cloud Notebooks require the use of the Anaconda Distribution.
Also:
- link: "Archives Unleashed Cloud Notebooks" to https://github.com/archivesunleashed/auk-notebooks
- link "Anaconda Distribution" to https://www.anaconda.com/distribution/
| <p class="about_p">For more information on what each notebook can do, see Ryan Deschamps’s <%= link_to('"Exploring Web Archival Data through Archives Unleashed Cloud Jupyter Notebook."', 'https://news.archivesunleashed.org/exploring-web-archival-data-through-archives-unleashed-cloud-jupyter-notebooks-7605c6ca2b33', target: '_blank') %></p> | ||
| <p class="about_p">Notebooks contain code and visualizations like the following one from <strong>auk-notebook-network</strong>:</p> | ||
| <%= image_tag("Notebook-04.png", alt: "The Jupyter Notebook Network example.", class:"body_img")%> | ||
| <p class="about_p">In order to use each notebook, click on the notebook from the directory list — the notebook will open in a new tab or window. Each notebook has been pre-loaded with sample data from the B.C. Teachers' Labor Dispute (2014) collection from the University of Victoria Libraries. This data is great to play with in order to learn how the tools work! Once you are ready to load your own data, there are a few extra steps to load it into the notebooks.</p> |
This comment has been minimized.
This comment has been minimized.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
ianmilligan1 commentedJul 4, 2019
GitHub issue(s):
#311
What does this Pull Request do?
This adds a new learning guide: "Getting Started with the Archives Unleashed Cloud Jupyter Notebooks," written by Sarah McTavish.
In addition, this PR:
How should this be tested?
TravisCI should turn green.
More importantly, others should give this a read and make sure it properly addresses how to install the Notebooks. I'll take the lead on updating the text and can chat with Sarah as needed.
Interested parties
@ruebot @SamFritz