CI: add dev container (#29)

Author: k1nho

.devcontainer/devcontainer.json

@@ -2,8 +2,7 @@
   "name": "NSDF INTERSECT",
   "image": "mcr.microsoft.com/devcontainers/python:3.10",
   "features": {
-    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
-    "ghcr.io/devcontainers/features/make:1": {}
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
   },
   "forwardPorts": [10042, 10043, 15672, 1883, 5672],
   "customizations": {
@@ -13,5 +12,6 @@
         "terminal.integrated.defaultProfile.linux": "bash"
       }
     }
-  }
+  },
+  "postCreateCommand": "pip install pyyaml numpy intersect-sdk[amqp]"
 }

README.md

@@ -30,6 +30,7 @@ This repository hosts the dashboard, dashboard service, storage service, and tes
   - [Transition client](#transition_clientpy)
 - [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)
 
@@ -44,7 +45,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 --platform linux/amd64 -t intersect-dashboard -f Dockerfile.dashboard .
+docker build -t intersect-dashboard -f Dockerfile.dashboard .
 ```
 
 #### Running the dashboard container
@@ -200,6 +201,46 @@ To stop and clean up the services.
 docker compose down
 ```
 
+## Running with codespaces
+
+Click the next button to open in GitHub Codespaces
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nsdf-fabric/NSDF-INTERSECT)
+
+Verify that you are using the `main` branch, the repository name `nsdf-fabric/NSDF-INTERSECT` and the dev container configuration `NSDF INTERSECT`. Then click on `Create Codespace`
+
+### 📦 Building the services
+
+Once the environment is created, we can build the services with the following:
+
+```bash
+make dashboard
+```
+
+```bash
+make service
+```
+
+```bash
+make storage
+```
+
+### 🌐 Setting up the network
+
+Next, we can build the networking for the system with compose as follows:
+
+```bash
+make up
+```
+
+### 🧪 Running experiment campaigns
+
+Finally, we can run a test client as follows:
+
+```bash
+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).

assets/team_logo.png

@@ -86,7 +86,7 @@ def prepare_bragg_messages(n: int = 1):
 def prepare_transition_message():
     return IntersectDirectMessageParams(
         destination="nsdf.cloud.diffraction.dashboard.dashboard-service",
-        operation="NSDFDashboard.get_transition_data",
+        operation="NSDFDashboard.get_transition_data_single",
         payload=TransitionData(
             id=str(uuid4()), temp=transition_data[0][0], ylist=transition_data[0][1:]
         ),
@@ -119,7 +119,7 @@ def main():
         "--bragg", action="store_true", default=False, help="send bragg file"
     )
     parser.add_argument(
-        "--tpoint", action="store_true", default=False, help="send transition data"
+        "--transition", action="store_true", default=False, help="send transition data"
     )
     parser.add_argument(
         "--next-temp",
@@ -135,7 +135,7 @@ def main():
     if args.bragg:
         for msg in prepare_bragg_messages(args.n):
             initial_messages.append(msg)
-    if args.tpoint:
+    if args.transition:
         initial_messages.append(prepare_transition_message())
     if args.next_temp:
         initial_messages.append(prepare_next_temperature_message(args.val))