77* [ Get the Superfacility API Credentials] ( #Get-the-Superfacility-API-Credentials )
88* [ For Maintainers] ( #For-Maintainers )
99 * [Generate the conda environment lock file](#Generate-the-conda-environment-lock-file)
10- * [Push the Docker container to NERSC](#Push -the-Docker-container-to-NERSC)
10+ * [Build and push the Docker container to NERSC](#Build-and-push -the-Docker-container-to-NERSC)
1111* [ References] ( #References )
1212
1313# Overview
@@ -79,10 +79,7 @@ conda-lock install --name synapse-gui environment-lock.yml
7979
80802 . Move to the [ root directory] ( ../ ) of the repository.
8181
82- 3 . Build the Docker image:
83- ``` bash
84- docker build --platform linux/amd64 -t synapse-gui -f dashboard.Dockerfile
85- ```
82+ 3 . Build the Docker image as described [ below] ( #build-the-docker-image ) .
8683
87844 . Run the Docker container:
8885 ``` bash
@@ -96,7 +93,8 @@ conda-lock install --name synapse-gui environment-lock.yml
9693
9794# Run the Dashboard at NERSC
9895
99- Coming soon.
96+ Connect to the [ dashboard] ( https://bellasuperfacility.lbl.gov/ ) deployed at NERSC through Spin and play around!
97+ Remember that you need to upload valid Superfacility API credentials in order to launch simulations or train ML models directly from the dashboard.
10098
10199# Get the Superfacility API Credentials
102100
@@ -144,17 +142,34 @@ Following the instructions at [docs.nersc.gov/services/sfapi/authentication/#cli
144142 conda-lock --file environment.yml --lockfile environment-lock.yml
145143 ```
146144
147- ## Push the Docker container to NERSC
145+ ## Build and push the Docker container to NERSC
148146
149147> [ !WARNING]
150148> Pushing a new Docker container affects the production dashboard deployed at NERSC through Spin.
151149
150+ > [ !NOTE]
151+ > This has been also automated through the Python script [ publish_container.py] ( ../publish_container.py ) , which can be executed via
152+ > ``` bash
153+ > python publish_container.py --gui
154+ > ` ` `
155+
152156> [! TIP]
153157> Prune old, unused images periodically in order to free up space on your machine:
154158> ` ` ` bash
155159> docker system prune -a
156160> ` ` `
157161
162+ # ## Build the Docker image
163+
164+ 1. Move to the root directory of the repository.
165+
166+ 2. Build the Docker image:
167+ ` ` ` bash
168+ docker build --platform linux/amd64 -t synapse-gui -f dashboard.Dockerfile
169+ ```
170+
171+ ### Push the Docker container
172+
1581731 . Move to the root directory of the repository.
159174
1601752 . Login to the [ NERSC registry] ( https://registry.nersc.gov ) :
@@ -175,12 +190,7 @@ Following the instructions at [docs.nersc.gov/services/sfapi/authentication/#cli
175190 docker push -a registry.nersc.gov/m558/superfacility/synapse-gui
176191 ```
177192
178- This has been also automated through the Python script [ publish_container.py] ( ../publish_container.py ) , which can be executed via
179- ``` bash
180- python publish_container.py --gui
181- ```
182-
183- ## References
193+ # References
184194
185195* [ Using NERSC's ` registry.nersc.gov ` ] ( https://docs.nersc.gov/development/containers/registry/ )
186196* [ Superfacility API authentication] ( https://docs.nersc.gov/services/sfapi/authentication/#client )
0 commit comments