diff --git a/JupyterNotebookTutorial.ipynb b/JupyterNotebookTutorial.ipynb deleted file mode 100644 index 7492d16..0000000 --- a/JupyterNotebookTutorial.ipynb +++ /dev/null @@ -1,163 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "**Adapted with permission** by Prof. Simone Deparis for MATH-251(c), adapted from the [Jupyter tutorial](https://github.com/aparrish/rwet/blob/master/jupyter-notebook-tutorial.ipynb) by [Allison Parrish](https://www.decontextualize.com/) and the version of Prof. Felix Naef for BIO-341." - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Jupyter Notebook Tutorial\n" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "A Jupyter Notebook gives you a convenient way to experiment with code (Python, R, Octave or C), interspersing your experiments with notes and documentation. You can do all of this without having to muck about on the command line, and the resulting file can be easily published and shared with other people.\n", - "\n", - "A Jupyter Notebook consists of a **number of \"cells\"**, stacked on the page from top to bottom. Cells can have text or code in them. You can create a new cell by clicking on the `+` icon in the toolbar above. \n", - "\n", - "New cells will by default be `Code` cells.\n", - "You can change a cell's type using the drop-down menu in the toolbar. Select either `Code` for code (Python, R, etc. depending on which programming language you have selected when creating the notebook) or `Markdown` for text. \n", - "\n", - "## Text cells\n", - "\n", - "Make a new cell, change its type to `Markdown`, type some stuff and press `Ctrl-Enter`. Jupyter Notebook will \"render\" the text and display it on the page in rendered format. You can hit `Enter` or click in the cell to edit its contents again. \n", - "\n", - "You can also press `Alt-Enter` to render the current cell and create a new cell. \n", - "\n", - "Text in `Markdown` cells is rendered according to a set of **conventions called `Markdown`**. `Markdown` is a simple language for marking up text with basic text formatting information (such as bold, italics, hyperlinks, tables, etc.). Here is [a tutorial](http://markdowntutorial.com/) for learning `Markdown` quickly, a [cheat sheet](https://medium.com/ibm-data-science-experience/markdown-for-jupyter-notebooks-cheatsheet-386c05aeebed) about the Markdown syntax and you can also find the [full reference](https://daringfireball.net/projects/markdown/syntax) of the Mardown syntax on John Gruber's website.\n", - "\n", - "\n", - "## Code cells\n", - "\n", - "Code cells make it possible to **embed a program** or pieces of program into a notebook, to execute them and **see the results** of its execution right away directly in the notebook.\n", - "\n", - "To execute a code cell, simply click in the cell then click on the \"play\" button in the tool bar just above the notebook, or type shift + enter.
\n" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "print(\"This is a code cell.\")\n", - "print(\"\")\n", - "print(\"Any Python code you type in this cell will be run when you press the 'Run' button,\")\n", - "print(\"or when you press Ctrl-Enter.\")\n", - "print(\"\")\n", - "print(\"If the code evaluates to something, or if it produces output, that output will be\")\n", - "print(\"shown beneath the cell after you run it.\")" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "print(\"If your Python code generates an error, the error will be displayed in addition\")\n", - "print(\"to any output already produced.\")\n", - "\n", - "1 / 0" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Any variables you define or modules you import in one code cell will be available in subsequent code cells. Start with this:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "import random\n", - "stuff = [\"cheddar\", \"daguerrotype\", \"elephant\", \"flea market\"]" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "... and in subsequent cells you can do this:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "print(random.choice(stuff))" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "You might have noticed that a *number between square brackets* has appeared at the left of the code cell after its execution. \n", - "This number indicates the **order in which the code cell has been executed**, with respect to the other code cells or to previous executions of the same code cell.\n", - "\n", - "The order in which different pieces of code are executed affects the execution results, which is why these numbers are important information to consider." - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Keyboard shortcuts\n", - "\n", - "As mentioned above, `Ctrl-Enter` runs the current cell; `Alt-Enter` runs the current cell and then creates a new cell. `Enter` will start editing whichever cell is currently selected. To quit editing a cell, hit `Esc`. \n", - "\n", - "If the cursor isn't currently active in any cell (i.e., after you've hit `Esc`), a number of other keyboard shortcuts are available to you:\n", - "\n", - "* `m` converts the selected cell to a Markdown cell\n", - "* `b` inserts a new cell below the selected one\n", - "* `x` \"cuts\" the selected cell; `v` pastes a previously cut cell below the selected cell\n", - "* `h` brings up a help screen with many more shortcuts.\n", - "\n", - "## Saving your work\n", - "\n", - "Hit `Ctrl-S` at any time to save your notebook. Jupyter Notebook also automatically saves occasionally. \n", - "\n", - "Make sure to give your notebook a descriptive name by right-clicking on the file in the left pane and choosing `Rename` in the menu. \n", - "\n", - "Notebooks you save will be available on your server whenever you log in again, from wherever you log into the server.\n", - "\n", - "You can \"download\" your notebook on your computer by right-clicking on the file in the left pane and choosing `Download` in the menu. You can also export your notebook in various formats via `File > Export as`. You can then export your notebook as a static PDF file, as a static HTML file (for, e.g., uploading to a web site), etc." - ] - } - ], - "metadata": { - "anaconda-cloud": {}, - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.6.9" - } - }, - "nbformat": 4, - "nbformat_minor": 4 -} diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 8af83a1..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright and License - -Copyright (c) 2019-2024 Center for Digital Education (CEDE), EPFL - -## Content Material - -All content material is made available under the Creative Commons Attribution license CC-BY 4.0. - -You are free: -* to Share---to copy, distribute and transmit the work -* to Remix---to adapt the work - -Under the following conditions: -* Attribution---You must attribute the work using "Copyright (c) CEDE, EPFL" (but not in any way that suggests that we endorse you or your use of the work). Where practical, you must also include a hyperlink to https://c4science.ch/source/noto-poc-notebooks/. - -With the understanding that: -* Waiver---Any of the above conditions can be waived if you get permission from the copyright holder. -* Other Rights---In no way are any of the following rights affected by the license: - * Your fair dealing or fair use rights; - * The author's moral rights; - * Rights other persons may have either in the work itself or in how the work is used, such as publicity or privacy rights. -* Notice---For any reuse or distribution, you must make clear to others the license terms of this work. The best way to do this is with a link to http://creativecommons.org/licenses/by/4.0/. - -For the full legal text of this license, please see: http://creativecommons.org/licenses/by/4.0/legalcode - - -## Software - -Except where otherwise noted, all software is made available under the OSI-approved BSD-3-Clause license (https://opensource.org/licenses/BSD-3-Clause): - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 76f2317..0000000 --- a/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Project title - -Start the README file by stating the name of your project or the name of your repository. - -## Project description - -We recommend that you provide a short description of your project, making sure to include relevant keywords for indexing. -The goal of this repository is to provide you with _template files_ that help you initialize your repository and that you can modify to fit your own needs and your own project. - -Then it is important to state the names of the authors and contributors of the project. -The contributors of this repository and the included template files are Cécile Hardebolle, Pierre-Olivier Vallès and Patrick Jermann, from the Center for Digital Education at EPFL. - -It is good practice to include the public URL of your repository. -This repository is available at: https://c4science.ch/source/noto-poc-notebooks/ - -And finally, contact information can also be helpful. -For any enquiries relating to this template or this repository, please contact: [noto-support@groupes.epfl.ch](mailto:noto-support@groupes.epfl.ch) - -## Copyright and license - -Providing licensing information is very important. A brief summary should be included into your README and then you should also provide a more detailed LICENSE file. - -All content in this repository is distributed publicly and openly under a Creative Commons Attribution license, [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/), and all code is under [BSD-3-Clause](LICENSE.md). - -## Table of contents - -This repository contains: -* a template `.gitignore` file -* a template `README.md` file -* a templace `LICENSE.md` file -* an example notebook