Skip to content

Commit

Permalink
Add more install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Tania Allard committed Apr 25, 2018
1 parent 6b69ab6 commit 6f8caf0
Showing 1 changed file with 202 additions and 37 deletions.
239 changes: 202 additions & 37 deletions Setup.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@
"# ⚙️ Workshop Setup\n",
"\n",
"\n",
"## Requirements\n",
"## Requirements\n",
"You must bring a laptop with a Mac, Linux,\n",
"or Windows operating system (not a tablet, Chromebook,\n",
" etc.). Make sure you have admin priviledges on the laptop so you can install the packages needed.\n",
" \n",
"\n",
"## What do I need to have installed?\n",
"To participate in the workshop, you will need access to the following software and tools:\n",
"## What do I need to have installed? \n",
"To participate in the workshop, you will need access to the following tools and software:\n",
"\n",
"- Bash shell\n",
"- Git\n",
"- Text editor\n",
"- Python 3.x\n",
"- pip\n",
"- Jupyter notebook\n",
Expand All @@ -26,10 +27,8 @@
"- nbval\n",
"- nbdime\n",
"- pandas\n",
"- Jupyterlab (optional)\n",
"- Text editor\n",
"- Travis CI\n",
"- GitHub\n",
"- matplotlib\n",
"- Jupyterlab (recommended)\n",
"\n",
"Please follow the instructions below to get these software installed.\n",
"\n",
Expand Down Expand Up @@ -161,18 +160,10 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 🐍 Python\n",
"### 🐍 Python\n",
"\n",
"Of course we could not let our main player out!!! To make it easier to deal with packages and files during the course we recommend using <a href=\"https://www.continuum.io/anaconda\">Anaconda</a>,\n",
" an all-in-one installer. If you prefer using other installation method it is fine as long as you have all the software needed. \n",
"Of course we could not let our main player out!!! **To make it easier to deal with packages and files during the course we will use <a href=\"https://www.continuum.io/anaconda\">Anaconda</a>**. Also this will come in handy during the workshop.\n",
" \n",
" We will teach Python using the IPython notebook, a programming environment\n",
" that runs in a web browser. For this to work you will need a reasonably\n",
" up-to-date browser. The current versions of the Chrome, Safari and\n",
" Firefox browsers are all\n",
" <a href=\"http://ipython.org/ipython-doc/2/install/install.html#browser-compatibility\">supported</a>\n",
" (some older browsers, including Internet Explorer version 9\n",
" and below, are not).\n",
" \n",
"📌 **Windows**\n",
"\n",
Expand Down Expand Up @@ -223,41 +214,215 @@
" </li>\n",
" <li>\n",
" Close the terminal window.\n",
" </ol>\n",
" \n",
" ---\n",
" If you used Anaconda you should now have Python 3.x as well as Jupyter notebooks. \n",
" And you should now be able to start them from your shell. Type:\n",
" `jupyter ntotebook` and this should start a server on your default web browser.\n",
" \n",
" If you don't have Anaconda installed, you can get the Jupyter notebooks typing the following commands on your shell:\n",
" ```bash\n",
"python3 -m pip install --upgrade pip\n",
"python3 -m pip install jupyter\n",
" </ol>\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Installing additional packages\n",
"\n",
"1. Download [environment.yml](https://raw.githubusercontent.com/trallard/ReproduciblePython/master/environment.yml) to your local computer by right-clicking on the following link: [environment.yml](https://raw.githubusercontent.com/trallard/ReproduciblePython/master/environment.yml)\n",
"2. Make sure you know where you saved the file\n",
"3. Open your shell and navigate to the location of the file, for example if you saved it in Desktop you would type in `cd Desktop`\n",
"4. Type in the following command to create an environment fro the file:\n",
"```bash\n",
"conda env create -f environment.yml\n",
"```\n",
"You should see the packages being installed. Note it could take a while so you can go and grab yourself a cup of coffee or tea ☕\n",
"\n",
"\n",
"If you have never used Jupyter notebooks you could have a look at this [Tutorial](https://www.dataquest.io/blog/jupyter-notebook-tutorial/) before the workshop.\n"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Getting your accounts ready\n",
"\n",
"### GitHub\n",
"\n",
"<br>\n",
"<div class='warn'> Note you do not need to do the following if you already have a GitHub account. You only need to make sure you know your username and password </div>\n",
"\n",
"If you have never used Jupyter notebooks you could have a look at this [Tutorial](https://www.dataquest.io/blog/jupyter-notebook-tutorial/) before the workshop."
"Go to the [GitHub homepage](https://github.com/) to register for a new account, you should see the following page\n",
"\n",
"<img src='./assets/gh.png' width=80%>\n",
"\n",
"\n",
"- Choose a username, email address and password.\n",
"- Click the green *Sign up* button\n",
"- Confirm your email address\n",
"- Choose the personal default plan\n",
"\n",
"### Travis CI\n",
"\n",
"Go to [https://travis-ci.org/](https://travis-ci.org/), if you do not have an account yet you should see the following landing page:\n",
"\n",
"<img src='./assets/travis1.png' width=80%>\n",
"\n",
"Click on the green *Sign up* button and login using your GitHub username and password\n",
"\n",
"\n",
"<img src='./assets/travis2.png'>"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Installing additional packages"
"## Additional notes\n",
"\n",
" We will teach Python using the IPython notebook, a programming environment\n",
" that runs in a web browser. For this to work you will need a reasonably\n",
" up-to-date browser. The current versions of the Chrome, Safari and\n",
" Firefox browsers are all\n",
" <a href=\"http://ipython.org/ipython-doc/2/install/install.html#browser-compatibility\">supported</a>\n",
" (some older browsers, including Internet Explorer version 9\n",
" and below, are not)."
]
},
{
"cell_type": "code",
"execution_count": 39,
"metadata": {
"deletable": false,
"editable": false
},
"outputs": [
{
"data": {
"text/html": [
"<link href=\"https://fonts.googleapis.com/css?family=Didact+Gothic|Dosis:400,500,700\" rel=\"stylesheet\"><style>\n",
"@font-face {\n",
" font-family: \"Computer Modern\";\n",
" src: url('http://mirrors.ctan.org/fonts/cm-unicode/fonts/otf/cmunss.otf');\n",
"}\n",
"/* div.cell{\n",
"width:800px;\n",
"margin-left:16% !important;\n",
"margin-right:auto;\n",
"} */\n",
"h1 {\n",
" font-family: 'Dosis', \"Helvetica Neue\", Arial, sans-serif;\n",
" color: #0B132B;\n",
"}\n",
"h2 {\n",
" font-family: 'Dosis', sans-serif;\n",
" color: #1C2541;\n",
"}\n",
"h3{\n",
" font-family: 'Dosis', sans-serif;\n",
" margin-top:12px;\n",
" margin-bottom: 3px;\n",
" color: #40a8a6;\n",
"}\n",
"h4{\n",
" font-family: 'Dosis', sans-serif;\n",
" color: #40a8a6;\n",
"}\n",
"h5 {\n",
" font-family: 'Dosis', sans-serif;\n",
" color: #40a8a6;\n",
"}\n",
"div.text_cell_render{\n",
" font-family: 'Didact Gothic',Computer Modern, \"Helvetica Neue\", Arial, Helvetica,\n",
" Geneva, sans-serif;\n",
" line-height: 130%;\n",
" font-size: 110%;\n",
" /* width:600px; */\n",
" /* margin-left:auto;\n",
" margin-right:auto; */\n",
"}\n",
"\n",
".text_cell_render h1 {\n",
" font-weight: 200;\n",
" font-size: 30pt;\n",
" /* font-size: 50pt */\n",
" line-height: 100%;\n",
" color:#0B132B;\n",
" margin-bottom: 0.5em;\n",
" margin-top: 0.5em;\n",
" display: block;\n",
"}\n",
"\n",
".text_cell_render h2{\n",
" font-weight: 500;\n",
"}\n",
"\n",
".text_cell_render h3{\n",
" font-weight: 500;\n",
"}\n",
"\n",
"\n",
".warning{\n",
" color: rgb( 240, 20, 20 )\n",
"}\n",
"\n",
"div.warn {\n",
" background-color: #FF5A5F;\n",
" border-color: #FF5A5F;\n",
" border-left: 5px solid #C81D25;\n",
" padding: 0.5em;\n",
"\n",
" color: #fff;\n",
" opacity: 0.8;\n",
"}\n",
"\n",
"div.info {\n",
" background-color: #087E8B;\n",
" border-color: #087E8B;\n",
" border-left: 5px solid #0B3954;\n",
" padding: 0.5em;\n",
" color: #fff;\n",
" opacity: 0.8;\n",
"}\n",
"\n",
"</style>\n",
"<script>\n",
"MathJax.Hub.Config({\n",
" TeX: {\n",
" extensions: [\"AMSmath.js\"]\n",
" },\n",
" tex2jax: {\n",
" inlineMath: [ ['$','$'], [\"\\\\(\",\"\\\\)\"] ],\n",
" displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"] ]\n",
" },\n",
" displayAlign: 'center', // Change this to 'center' to center equations.\n",
" \"HTML-CSS\": {\n",
" styles: {'.MathJax_Display': {\"margin\": 4}}\n",
" }\n",
" });\n",
" </script>\n"
],
"text/plain": [
"<IPython.core.display.HTML object>"
]
},
"execution_count": 39,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"from IPython.core.display import HTML\n",
"\n",
"\n",
"def css_styling():\n",
" styles = open(\"styles/custom.css\", \"r\").read()\n",
" return HTML(styles)\n",
"css_styling()"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"🔹 **Windows**\n",
"\n",
"🔹 **MAC OS X**\n",
" \n",
"🔹 **Linux** "
]
"source": []
}
],
"metadata": {
Expand Down

0 comments on commit 6f8caf0

Please sign in to comment.