From 146cf53b12db9d69cd31cd7cfbcbd53e5404b0a1 Mon Sep 17 00:00:00 2001
From: Lukas Mahler <e11908553@student.tuwien.ac.at>
Date: Fri, 29 Sep 2023 20:06:06 +0200
Subject: [PATCH] add refs to readme
---
README.md | 23 +++++++++++++----------
notebooks/6_report.ipynb | 37 -------------------------------------
2 files changed, 13 insertions(+), 47 deletions(-)
delete mode 100644 notebooks/6_report.ipynb
diff --git a/README.md b/README.md
index 49fedc5..980c77c 100644
--- a/README.md
+++ b/README.md
@@ -9,25 +9,28 @@ Install poetry via pip or conda and run
Following packages are additionally needed: git-lfs, libsnfile1 (needed for librosa).
Install them with your package manager.
-To authenticate with the DBRepo and Invenio servers, rename example-config.yml located in the config folder to config.yml and enter you credentials in the placeholders.
+To authenticate with the DBRepo and Invenio servers, rename example-config_<platform>.yml located in the config folder
+to config_<platform>.yml and enter you credentials in the placeholders.
## Usage
-The main notebook is called ismir_presentation.ipynb located in the notebooks folder.
+The main notebook is located in notebooks/main.ipynb. It executes the full workflow of the project.
+Alternatively, notebooks/standalone.ipynb also contains the full workflow.
-## Support
-
-
-## Roadmap
+A docker image is also provided for download on invenio, containing a running jupyter instance with all dependencies installed.
+## Roadmap & Project Status
+The project is done in the context of a bachelor thesis, extensions are not planned for now.
## Contributing
## Authors and acknowledgment
-
+Lukas Mahler
## License
-
-## Project status
-Currently in early development
+## References
+Docker Image on invenio: https://researchdata.tuwien.ac.at/
+DBRepo: https://dbrepo1.tuwien.ac.at/
+Invenio: https://researchdata.tuwien.ac.at/
+Thesis: https://repositum.tuwien.ac.at/
diff --git a/notebooks/6_report.ipynb b/notebooks/6_report.ipynb
deleted file mode 100644
index 6accbc1..0000000
--- a/notebooks/6_report.ipynb
+++ /dev/null
@@ -1,37 +0,0 @@
-{
- "cells": [
- {
- "cell_type": "code",
- "execution_count": null,
- "metadata": {
- "collapsed": true,
- "jupyter": {
- "outputs_hidden": true
- }
- },
- "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.10.13"
- }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}
--
GitLab