diff --git a/README.md b/README.md index 3540e0f..745c6fc 100644 --- a/README.md +++ b/README.md @@ -26,23 +26,35 @@ cd acsmnode ## Run the Data Chain App -1. Open **PowerShell as Administrator** and navigate to the `acsmnode` repository. -2. Open **Docker Desktop**, then build the container image: +1. Open **PowerShell as Administrator** and navigate to the `acsmnode` repository. +2. Create a `.env` file in the root of `acsmnode/`. +3. **Securely store your network drive access credentials** in the `.env` file by adding the following lines: + ```plaintext + CIFS_USER= + CIFS_PASS= + ``` + **To protect your credentials:** + - Do not share the .env file with others. + - Ensure the file is excluded from version control by adding .env to your .gitignore and .dockerignore files. +4. Open **Docker Desktop**, then build the container image: ```bash docker build -t datachain_processor . ``` -3. Run the app: +5. Run the app: ```bash docker compose --file docker-compose.yml start datachain_processor -4. Stop the app: +6. Access: + - **Jupyter Lab**: [http://localhost:8889/lab/tree/notebooks/](http://localhost:8889/lab/tree/notebooks/) + +7. Stop the app: In the previously open PowerShell terminal, enter: ```bash Ctrl + C + ``` After the container is properly Stopped, remove the container process as: + ```bash docker rm $(docker ps -aq --filter ancestor=datachain_processor) ``` -4. Access: - - **Jupyter Lab**: [http://localhost:8889/lab/tree/notebooks/](http://localhost:8889/lab/tree/notebooks/) ## Set Up the Python Environment diff --git a/TODO.md b/TODO.md index 7e82086..3ff51ad 100644 --- a/TODO.md +++ b/TODO.md @@ -1,5 +1,8 @@ # TODO -* [New] FLAGGING APP. Review data flagging app. For some reason Chl_10000 channel not showing and parent provance recording is wrong. +* [New] Create data flows to validate and replace existing data chain params. data/campaignData/param/ -> pipelines/params and campaignDescriptor.yaml -> acsm data converter. +* [New] DIMA. Add dictionaries to explain variables at different levels. +* [New] DIMA. Modify data integration pipeline to not add current datetime in filename when not specified. +* [New] DIMA. Set data/ folder as default and only possible output folder * [New] DIMA. Review DataManager File Update. Generated CSV files are not transfering properly. * [New] DIMA. Ensure code snippets that open and close HDF5 files do so securly and do not leave the file locked * [New] DIMA. Revise default csv file reader and enhance it to infer datetime column and format.