Parcourir la source

Add requirements files

M. Sonntag il y a 2 ans
Parent
commit
0a3e381904
4 fichiers modifiés avec 126 ajouts et 0 suppressions
  1. 1 0
      .gitignore
  2. 19 0
      README.md
  3. 5 0
      python-requirements.txt
  4. 101 0
      requirements.ipynb

+ 1 - 0
.gitignore

@@ -0,0 +1 @@
+.ipynb_checkpoints/*

+ 19 - 0
README.md

@@ -1,2 +1,21 @@
 # NIX-Neo-workshop
 
+This repository contains all files required for the INCF NIX-Neo workshop.
+
+## Requirements
+
+To benefit from the workshop you need to have to have experience with the Python programming language.
+
+Before attending the workshop please make sure that either the machine you are working on is able to run jupyter notebooks and install python packages. To make sure your machine is set up for the workshop, please run the "requirements.jpynb" jupyter notebook before the workshop. We recommend using [Anaconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/) as a Python virtual environment to make sure you are running the workshop in a clean Python environment.
+
+### Using Binder to run Jupyter notebooks online
+
+If you are not able to use Jupyter notebooks on your machine, you can use [Binder](https://jupyter.org/binder) to run the required notebooks online. In this case please be aware, that any changes made to Jupyter notebooks and any files created are remote - you will need to manually save them to your local machine if you want to keep them.
+
+To test running a Jupyter notebook from our course with Binder, 
+- move to https://mybinder.org/
+- select "Git repository" and add the URL "https://gin.g-node.org/INCF-workshop-2021/NIX-Neo-workshop/requirements.ipynb"
+- press the "launch" button and run the notebook as a test
+
+Please note that Binder is a free service and it might take a while for Notebooks to start and be available. Also it can happen, that after inactivity a running Binder notebook will be shut down automatically, so save files and progress locally on a regular basis.
+

+ 5 - 0
python-requirements.txt

@@ -0,0 +1,5 @@
+jupyter
+matplotlib
+nixio
+neo
+

+ 101 - 0
requirements.ipynb

@@ -0,0 +1,101 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This notebook will setup your working Python environment with all dependencies required for the Workshop and test that the dependencies have been correctly installed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# the following python dependencies will be installed.\n",
+    "!cat python-requirements.txt"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pip install -r python-requirements.txt"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Restart the kernel now if required"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import nixio"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "nixfile = nixio.File.open('setup_file.nix', nixio.FileMode.ReadWrite)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "nixfile.close()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import neo"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "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.8.10"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}