Merge pull request #2 from sdsc-ordes/feat/tentris-quickstart

Feat/tentris quickstart

Author: rmfranken

2025-mini-hackathon.md

@@ -0,0 +1,39 @@
+# How to participate in the Mini-Hackathon using Renku?
+
+## Renku Workflow
+
+1. Choose your team captain !
+2. Each team member makes an account on [RenkuLab](https://renkulab.io/)
+3. The team captain copies the [project quickstart](https://renkulab.io/p/open-pulse-hackathon/quickstart) into their renku user profile
+4. Captain adds all his team members (renku users) to that project
+5. Team sets up their project: add your own code repository and add your own data (Notes: do any code/data connections before launching a work session.)
+6. If you want to launch the quickstart session, you will be prompted to enter the connection secrets (see documents).
+7. If you want to launch a session with all the code from all connected code repositories, we recommend launching the standard VSCode interface of Renku and working there.
+
+![alt text](docs/images/Renku.png)
+
+Here are the [Open Pulse Hackathon Renku Project](https://renkulab.io/g/open-pulse-hackathon) and [the template project](https://renkulab.io/p/open-pulse-hackathon/quickstart)from which you can kick off.
+
+For further Jupyter Hub Documentation you can read [here](https://jupyterhub.readthedocs.io/en/stable/);
+
+You can also clone the repository and work locally via the `uv` setup if you prefer. 
+
+## How to submit your project?
+
+Each team will be asked to submit their project through [a simple online form](https://docs.google.com/forms/d/e/1FAIpQLSeha3yJF3rxULynG0JnqPsM7d15Qk_6kvaVGmTH3rrDIipA_g/viewform?usp=publish-editor).
+We expect every team to prepare:
+
+- One slide presentation summarizing the project’s idea, impact, and main results.
+- A link to a code repository (e.g. GitHub, GitLab, or similar).
+
+You’re also welcome to include supplemental material such as:
+
+- Renku projects or workflows
+- Deployed web applications or dashboards
+- Documentation, datasets, or other resources that support your work
+
+During the final session, all projects will be presented and participants will vote using stickers to recognize the
+
+## Credits
+
+TBD.

README.md

@@ -43,13 +43,17 @@ To be extended....
 ![alt text](docs/images/Neo4J.png)
 
 Link to Neo4j Open Pulse Instance: 
+- Neo4J Browser: http://128.178.219.51:7503
+- Neo4J Bolt: http://128.178.219.51:7504
 Documentation: https://neo4j.com/docs/
-Cypher Tutorial: 
+Cypher Tutorial: https://neo4j.com/docs/cypher-manual/current/appendix/tutorials/
 
 #### CSV Example dataset
 
 As an alternative to the interaction with NEO4j we compiled a subset of the graph in csv format which can be found in  `data/community-network`. 
 
+Code for loading this csv is available in the `neo4j-quickstart` notebook.
+
 ### Repositories Metadata
 
 To be extended....
@@ -65,22 +69,3 @@ SPARQL Tutorial: https://sparql.dev/
 #### Document based Metadata
 
 As an alternative to SPARQL we compiled the metadata in a much more familiar formar and included a subset in `data/entities-metadata`
-
-
-## How to participate in the Mini-Hackathon using Renku?
-
-TBD: Describe here the user flow including Renku use. 
-
-![alt text](docs/images/Renku.png)
-
-Link to Renku Project: https://renkulab.io/p/robin.franken-1/quickstart
-Jupyter Hub Documentation: https://jupyterhub.readthedocs.io/en/stable/
-
-## How to submit your project?
-
-TBD..
-
-
-## Credits
-
-TBD.

docs/images/Renku.png

@@ -0,0 +1,60 @@
+### 🚀 Part 1: Create the Environment (In Your Terminal)
+
+First, install `uv`. Then, run **all** of the following commands in your system terminal (like Terminal, PowerShell, or bash) from the root folder of the `tentris-quickstart` project.
+
+**Do not** run these in a notebook cell.
+
+**1. Install `uv` (if not already done):**
+Run **one** of these commands in your terminal.
+
+* *On macOS / Linux:*
+    ```bash
+    curl -LsSf [https://astral.sh/uv/install.sh](https://astral.sh/uv/install.sh) | sh
+    ```
+* *On Windows (PowerShell):*
+    ```bash
+    pip install uv
+    ```
+
+> **Note:** After installing, you may need to **restart your terminal or VS Code** for the `uv` command to be recognized.
+
+**2. Create the Environment and Install Packages:**
+These commands will create a local `.venv` folder, install all project dependencies (including `ipykernel`), and register it as a named kernel for Jupyter/VS Code.
+
+```bash
+# 1. Clean up any old environment (optional, but safe)
+rm -rf .venv
+
+# 2. Create a new, empty virtual environment
+uv venv
+
+# 3. Install all project dependencies from the pyproject.toml file
+uv pip install "./src/tentris-quickstart[dev]"
+```
+
+**3. Register the Kernel:**
+Now, run the command for your operating system to make the new environment visible to Jupyter/VS Code.
+
+* *On macOS / Linux:*
+    ```bash
+    .venv/bin/python -m ipykernel install --user --name="tentris-env" --display-name="Python (Tentris)"
+    ```
+* *On Windows (PowerShell):*
+    ```bash
+    .venv\Scripts\python.exe -m ipykernel install --user --name="tentris-env" --display-name="Python (Tentris)"
+    ```
+
+---
+
+### 💻 Part 2: Run the Notebook (In VS Code)
+
+Now that your environment is built and registered, you can start the notebook.
+
+1.  **Open VS Code:** Open the *entire* `tentris-quickstart` folder in VS Code (File > Open Folder...).
+2.  **Open this Notebook:** Open the `.ipynb` notebook file.
+3.  **Select the Kernel:**
+    * Click the "Select Kernel" button in the top-right corner of the notebook.
+    * From the dropdown list, choose **"Python (Tentris)"**. This is the name you just registered.
+    * If VS Code prompts you, it may also auto-detect the `.venv` folder. Selecting that also works, but the named kernel is more explicit.
+
+You are now ready to run the cells in the notebook.

src/tentris-quickstart/README.md

@@ -2,24 +2,19 @@
 name = "tentris-notebook-env"
 version = "0.1.0"
 description = "Python environment for the Tentris SPARQL query notebook."
-
-# Specify the minimum Python version required by Tentris
 requires-python = ">=3.12"
 
-# Define the project dependencies
 dependencies = [
     "tentris",
     "rdflib",
     "pandas",
-    "ipykernel",
     "numpy",
     "pytz",
     "pyparsing",
 ]
 
-[dependency-groups]
+[project.optional-dependencies]
 dev = [
-    "ipykernel>=7.0.1",
-]
-
-
+    "ipykernel",
+    "jupyter-client" 
+]