Dev (#3)

* Added notebooks and manifest file so the notebooks are distributed with both the binary and source distribution of the package.

Made sure the working directory for the IJupyter server is correctly set to the notebooks root directory.

* Added dependencies

* Refactored __main__.py

* Decided on naming scheme:
Package name is "tud-ais", import name is "tudais", shell command to start server in notebook directory is "tud-ais".

* Added TUD-CD-theme-usage via tudthemes-package (#2)

* adds a dash to the package name
fixes wrong path in MANIFEST.in
starts work on README

* removes dash from module name

* adds instructions on how to run the lab to the readme

* fixes a typo in mailto link

Co-authored-by: ArneLF <[email protected]>

MANIFEST.in

@@ -0,0 +1 @@
+graft tudais/notebooks

README.md

@@ -1,2 +1,65 @@
-# tud-ais-package
-Supplemental material for the lecture Angewandte Intelligente Signalverarbeitung at TU Dresden
+# TUD AIS
+This package contains lab material for the module Angewandte Intelligente Signalverarbeitung offered by Professor 
+Birkholz at TU Dresden.
+
+
+## Setup (Linux, Mac OS X, Windows)
+To obtain the lab material, you can simply install the package just like any other Python package. We recommend 
+setting up a virtual environment before installing. The steps to do so are as follows:
+
+### Step 0: Get Python
+If you don't already have it installed, [download and install the current version of Python for your platform.](https://www.python.org/downloads/)
+
+### Step 1: Set up your working directory
+1. Create a folder in a suitable location where all the lab material will be placed 
+(e.g. ``C:\Users\MyUserName\Documents\TUD-AIS-Lab``). Just to be safe, choose a path that is not too long and that 
+does not contain spaces.
+2. Open a shell (Linux), terminal (Mac), or command prompt (Windows) and navigate to the created folder.
+3. Create a virtual environment called ``.ais-env`` by entering the following command:
+    ```bash
+    python -m venv .ais-env
+    ```
+4. Activate the virtual environment by entering the following command depending on your operating system:
+
+    **Linux or Mac**:
+    ```bash
+    source .ais-env/bin/activate
+    ```
+    **Windows**:
+    ```
+    .ais-env\Scripts\activate.bat
+    ```
+    You should now see the name of your environment showing up in parentheses at the beginning of the line:
+    ![Screenshot showing the active virtual environment in the command prompt](doc/img/fig-activate-venv.png "Active virtual environment")
+
+    You can deactivate the virtual environment at any time by entering the command ``deactivate``.
+
+### Step 2: Install the lab material
+1. Make sure that your virtual environment is active (see Step 1.4 above).
+2. Install the lab material by entering the following command:
+    ```
+    pip install tudais
+    ```
+   This will install all dependencies of the lab materials and the lab materials 
+   itself. It may take a while.
+
+### Step 3: Start the lab
+1. Make sure that your virtual environment is active (see Step 1.4 above).
+2. Enter the following command:
+   ```
+   tud-ais
+   ```
+   This will open your default web browser and show the root folder of the lab material.
+   
+
+If you run into any problems in this process, contact [Simon Stone](mailto:[email protected]?subject=Praktikum%20AIS) for 
+assistance.
+   
+   
+
+
+ 
+ 
+
+
+

setup.py

@@ -1,11 +1,24 @@
 from setuptools import setup
 
-setup(name='tud-ais',
+setup(name='tudais',
       version='0.1',
-      description='Supplemental material for the lecture Angewandte Intelligente Signalverarbeitung at TU Dresden',
+      description='Supplemental material for the lecture Angewandte '
+                  'Intelligente Signalverarbeitung at TU Dresden',
       url='http://github.com/TUD-STKS/tud-ais-package',
       author='Simon Stone',
       author_email='[email protected]',
       license='MIT',
-      packages=['tud-ais']
+      packages=['tudais'],
+      include_package_data=True,
+      install_requires=[
+          'jupyterlab',
+          'pandas',
+          'scikit-learn',
+          'tudthemes'
+      ],
+      entry_points={
+          'console_scripts': [
+              'tud-ais = tudais.__main__:start_jupyter_server',
+          ]
+      }
       )