Introduction

This repository is for the source code of the NOVA dashboard (running at https://nova.ornl.gov). The dashboard provides a way for users to launch interactive tools without going through Calvera.

Install dependencies

You will need to install Pixi and pnpm. After doing so, you can run the following commands to build the source code.

pixi install
pixi run ./manage.py migrate

cd src/vue
pnpm i

Run

To configure and run the app properly, a .env file is needed in the top level directory of this repository. A sample file .env.sample is provided that describes the available configuration options. Because your .env may contain secrets, make sure this does not get committed to the upstream repository. You can also set the environment variables manually in your environment or prefix them to your run command.

After your environment is configured, run the following to start the client:

cd src/vue
pnpm run dev --host 0.0.0.0 --port 5173

After that to start the application (from the root directory):

pixi run ./manage.py runserver_plus --insecure 0.0.0.0:8080

Develop

Pixi will create a .pixi folder containing a virtual environment for this project. Please configure your IDE to use this environment.

Maintaining healthy interaction between this dashboard and Galaxy is critical to the long-term health of this project. Please read, refer to, and help maintain docs/galaxy-interactions.md when working to ensure that we manage interaction with Galaxy in a stable manner.

Load testing

Artillery load profiles for the dashboard API, the static client and the Galaxy calls the browser makes directly live in loadtest/. See loadtest/README.md for how to run them.

cd loadtest
pnpm install
pnpm run load:local

Docker

Build the image

without conda and mantid:

docker build . -f dockerfiles/Dockerfile -t app --platform {your_build_platform}

Run the container

docker run -p 8080:8080 -it --env-file {path/to/your/.env} app

then open your browser at http://localhost:8080