docs: adding tag test for local dev

Author: k1nho

Makefile

@@ -1,34 +1,44 @@
-# Local
+# Dev
+.PHONY: dev
 dev:
 	@panel serve ./src/dashboard.py --show --dev
+
+.PHONY: all
+all:
+	@docker build -t intersect-dashboard:test services/nsdf_intersect_dashboard
+	@docker build -t intersect-service:test services/nsdf_intersect_service
+	@docker compose -f compose_local.yaml up -d
+
 # Docker
+.PHONY: dashboard
 dashboard:
-	@docker build -t intersect-dashboard:uv services/nsdf_intersect_dashboard
+	@docker build -t intersect-dashboard services/nsdf_intersect_dashboard
 
+.PHONY: service
 service:
-	@docker build -t intersect-service:uv services/nsdf_intersect_service
+	@docker build -t intersect-service services/nsdf_intersect_service
 
+.PHONY: storage
 storage:
-	@docker build -t intersect-storage:uv services/nsdf_intersect_storage 
+	@docker build -t intersect-storage services/nsdf_intersect_storage 
+
 
+.PHONY: up
 up:
 	@docker compose -f compose_local.yaml up -d
 
+.PHONY: down
 down:
 	@docker compose -f compose_local.yaml down
 
-deploy:
-	@docker compose up -d
-
-undeploy:
-	@docker compose down
-
+.PHONY: rmvolumes
 rmvolumes:
 	@docker volume rm nsdf-intersect_intersect_bragg_volume nsdf-intersect_intersect_transition_volume nsdf-intersect_intersect_andie_volume nsdf-intersect_intersect_scientist_cloud_volume
 
 # clients
-
+.PHONY: realtime
 realtime:
 	@python clients/realtime_client.py
+.PHONY: transition
 transition:
 	@python clients/transition_client.py

README.md

@@ -15,6 +15,7 @@ This repository hosts the dashboard, dashboard service, storage service, and tes
 
 #### Table of Contents
 
+- [Quick Start](#-quick-start)
 - [Dashboard](#-dashboard)
   - [Building dashboard image](#building-the-dashboard-image)
   - [Running the dashboard container](#running-the-dashboard-container)
@@ -25,15 +26,37 @@ This repository hosts the dashboard, dashboard service, storage service, and tes
   - [Building storage service image](#building-the-storage-service-image)
   - [Running the storage service container](#running-the-storage-service-container)
 - [Testing Clients](#-testing-with-the-client)
-  - [Single file client](#single_clientpy)
-  - [Real-time client](#realtime_clientpy)
-  - [Transition client](#transition_clientpy)
+  - [Real-time client](#realtime_client)
+  - [Single file client](#single_client)
+  - [Transition client](#transition_client)
 - [Running all services](#-running-all-services)
 - [Running with pre-built images](#running-with-pre-built-images)
 - [Running with codespaces](#running-with-codespaces)
 - [Authors](#authors)
 - [Acknowledgements](#acknowledgements)
 
+## ⚡Quick Start
+
+To get started, you can build and launch all the services with the following command:
+
+```bash
+make all
+```
+
+Then, you can visualize the dashboard at `http://localhost:10042`.
+
+Lastly, simulate networking of the service and dashboard with the following command:
+
+```bash
+make realtime
+```
+
+To cleanup, you can run:
+
+```bash
+make down
+```
+
 ## 📈 Dashboard
 
 The dashboard is the visualization component for monitoring the experiment in real-time.
@@ -45,7 +68,7 @@ The dashboard is the visualization component for monitoring the experiment in re
 To build the Docker image for the dashboard, run the following:
 
 ```bash
-docker build -t intersect-dashboard -f Dockerfile.dashboard .
+make dashboard
 ```
 
 #### Running the dashboard container
@@ -59,7 +82,6 @@ docker run --rm -p 10042:10042 intersect-dashboard
 ## 🖥️ Dashboard service
 
 The dashboard service uses [intersect-sdk](https://github.com/INTERSECT-SDK/python-sdk) to enable endpoints that work with message brokers (i.e RabbitMQ).
-The service will include three endpoints to serve the dashboard component: `get_bragg_data`, `get_transition_data`, and `get_next_temperature`.
 
 ### 🐳 Docker
 
@@ -68,7 +90,7 @@ The service will include three endpoints to serve the dashboard component: `get_
 To build the Docker image for the service, run the following:
 
 ```bash
-docker build -t intersect-service -f Dockerfile.dashboard_service .
+make service
 ```
 
 #### Running the dashboard service container
@@ -90,7 +112,7 @@ The storage service interfaces with Scientist Cloud to persist the data that is
 To build the Docker image for the storage service, run the following:
 
 ```bash
-docker build -t intersect-storage -f Dockerfile.storage_service .
+make storage
 ```
 
 #### Running the storage service container
@@ -103,10 +125,21 @@ docker run --rm -p 10044:10044 intersect-storage
 
 ## 🧪 Testing with the client
 
-To test the networking of the service and the observer on the dashboard, we can use intersect-sdk to create clients that serve the purpose of simulating
-the traffic through the message broker. We have two clients.
+To test the networking of the service and the dashboard, we can use intersect-sdk to create clients that serve the purpose of simulating
+the traffic through the message broker. We have three clients.
 
-### single_client.py
+### Realtime Client
+
+This is a client that implements a message stack with different events (get_bragg_data, get_transition_data, get_next_temperature) and wait times, in order to simulate a real-time stream of events. More information
+on this type of client here [counting example](https://intersect-python-sdk.readthedocs.io/en/latest/examples/counting.html). Use this client to test all the dashboard functionality.
+
+To run this client make sure you have the service running, then you can execute the following:
+
+```bash
+make realtime
+```
+
+### Single Client
 
 This is a simple client that sends only one file.
 
@@ -130,18 +163,7 @@ python clients/single_client.py --transition
 python clients/single_client.py --next-temp --val 30.0
 ```
 
-### realtime_client.py
-
-This is a client that implements a message stack with different events (get_bragg_data, get_transition_data, get_next_temperature) and wait times, in order to simulate a real-time stream of events. More information
-on this type of client here [counting example](https://intersect-python-sdk.readthedocs.io/en/latest/examples/counting.html).
-
-To run this client make sure you have the service running, then you can execute the following:
-
-```bash
-python clients/realtime_client.py
-```
-
-### transition_client.py
+### Transition Client
 
 This is a client that implements a message stack for testing the transition plot. The transition plot receives the type TransitionData which contains a campaign ID, temperature, and a variable size y-list.
 The client can simulate a full campaign for the transition plot via its two arguments `--n` for number of points `--ny` for y-list length as follows.
@@ -244,12 +266,11 @@ make transition
 ## Authors
 
 This project was created by the [NSDF team](https://nationalsciencedatafabric.org/contributors.html), and the [INTERSECT team](https://www.ornl.gov/intersect).
-To reach out email us at info@nationalsciencedatafabric.org and Dr. Michela Taufer mtaufer@utk.edu.
+To reach out email us at [info@nationalsciencedatafabric.org](mailto:info@nationalsciencedatafabric.org) and Dr. Michela Taufer [mtaufer@utk.edu](mtaufer@utk.edu).
 
 ## Acknowledgements
 
 The authors would like to express the gratitude to:
 
 - NSF through the awards 2138811, 2103845, 2334945, 2138296, and 2331152.
 - VisStore/ ScientistCloud [link](https://www.visoar.net/)
-- The Seal Storage Team [link](https://sealstorage.io/)

clients/short_list_of_data.txt

@@ -1,20 +1,6 @@
+./clients/GSAS/NOM168361tof.gsa
+./clients/GSAS/NOM168362tof.gsa
 ./clients/GSAS/NOM168363tof.gsa
 ./clients/GSAS/NOM168364tof.gsa
 ./clients/GSAS/NOM168365tof.gsa
 ./clients/GSAS/NOM168366tof.gsa
-./clients/GSAS/NOM168367tof.gsa
-./clients/GSAS/NOM168368tof.gsa
-./clients/GSAS/NOM168369tof.gsa
-./clients/GSAS/NOM168370tof.gsa
-./clients/GSAS/NOM168371tof.gsa
-./clients/GSAS/NOM168372tof.gsa
-./clients/GSAS/NOM168373tof.gsa
-./clients/GSAS/NOM168374tof.gsa
-./clients/GSAS/NOM168375tof.gsa
-./clients/GSAS/NOM168376tof.gsa
-./clients/GSAS/NOM168377tof.gsa
-./clients/GSAS/NOM168378tof.gsa
-./clients/GSAS/NOM168379tof.gsa
-./clients/GSAS/NOM168380tof.gsa
-./clients/GSAS/NOM168381tof.gsa
-./clients/GSAS/NOM168382tof.gsa

clients/single_client.py

@@ -26,7 +26,7 @@
 from schema import FileType, TransitionData, NextTemperature
 
 logging.basicConfig(level=logging.INFO)
-CONFIG_CLIENT = "config/config_client.yaml"
+CONFIG_CLIENT = os.path.join(os.getcwd(), "clients/config/config_client.yaml")
 
 transition_data = [
     [284.89, 0.9353496748096445, 1.5583828040832086],

compose_local.yaml

@@ -24,7 +24,7 @@ services:
       timeout: 10s
 
   dashboard:
-    image: "intersect-dashboard:uv"
+    image: "intersect-dashboard:test"
     container_name: dashboard
     ports:
       - "10042:10042"
@@ -45,7 +45,7 @@ services:
       - intersect_scientist_cloud_volume:/app/scientist_cloud_volume
 
   dashboard_service:
-    image: "intersect-service:uv"
+    image: "intersect-service:test"
     container_name: dashboard_service
     ports:
       - "10043:10043"