diff --git a/Setup.ipynb b/Setup.ipynb index b32abe2..0b8648d 100644 --- a/Setup.ipynb +++ b/Setup.ipynb @@ -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", @@ -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", @@ -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 Anaconda,\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 Anaconda**. 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", - " supported\n", - " (some older browsers, including Internet Explorer version 9\n", - " and below, are not).\n", " \n", "📌 **Windows**\n", "\n", @@ -223,27 +214,207 @@ " \n", "
  • \n", " Close the terminal window.\n", - " \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", + " \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", + "
    \n", + "
    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
    \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", + "\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", + "\n", + "\n", + "Click on the green *Sign up* button and login using your GitHub username and password\n", + "\n", + "\n", + "" ] }, { "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", + " supported\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": [ + "\n", + "\n" + ], + "text/plain": [ + "" + ] + }, + "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()" ] }, { @@ -251,13 +422,7 @@ "execution_count": null, "metadata": {}, "outputs": [], - "source": [ - "🔹 **Windows**\n", - "\n", - "🔹 **MAC OS X**\n", - " \n", - "🔹 **Linux** " - ] + "source": [] } ], "metadata": {