Update README.md campaign descriptor template and docker environment

This commit is contained in:
2025-06-18 16:33:17 +02:00
parent f9b9e1226b
commit 490a542126
4 changed files with 161 additions and 4 deletions

View File

@ -1,4 +1,4 @@
# IDEAR FAIRification Toolkit
# IDEAR Project Name
This is a **containerized, JupyterLab-based data toolkit** developed as part of the IDEAR project. It supports efficient, reproducible, and metadata-enriched data processing workflows for instrument-generated datasets.
@ -75,13 +75,14 @@ cd <your-repo-name>
This toolkit includes a containerized JupyterLab environment for executing the data processing pipeline, plus an optional dashboard for manual flagging.
1. Open **PowerShell as Administrator** and navigate to the `acsmnode` repository.
2. Create a `.env` file in the root of `acsmnode/`.
1. Open **PowerShell as Administrator** and navigate to the `your-repo-name` repository.
2. Create a `.env` file in the root of `your-repo-name/`.
3. **Securely store your network drive access credentials** in the `.env` file by adding the following lines:
```plaintext
CIFS_USER=<your-username>
CIFS_PASS=<your-password>
JUPYTER_TOKEN=my-token
NETWORK_MOUNT=//your-server/your-share
```
**To protect your credentials:**
- Do not share the .env file with others.
@ -103,7 +104,7 @@ This toolkit includes a containerized JupyterLab environment for executing the d
docker compose up idear_processor_networked
6. Access:
- **Jupyter Lab**: [http://localhost:8889/lab/tree/notebooks/](http://localhost:8889/lab/tree/notebooks/)
- **Jupyter Lab**: [http://localhost:8889/lab/tree/](http://localhost:8889/lab/tree/)
7. Stop the app:
In the previously open PowerShell terminal, enter: