Skip to main content

Run Computation

Generate this Task Flow​

cd src/pages
npx degit strudel-science/strudel-kit/src/pages/run-computation my-run-computation

File Structure​

run-computation
├── -components
│  └── NewScenarioModal.tsx # Modal component for adding a new computation scenario
├── -context
│  ├── ContextProvider.tsx # State management for this Task Flow
│  └── actions.ts # Action functions that control the state
├── -tests
│  └── run-computation.cy.ts # End-to-end test for this Task Flow
├── _layout
│  ├── $id
│  │  ├── _layout
│  │  │  ├── data-inputs.tsx # Inputs page
│  │  │  ├── results.tsx # Results page
│  │  │  ├── running.tsx # Running in progress page
│  │  │  └── settings.tsx # Settings page
│  │  └── _layout.tsx # Breadcrumb layout wrapper
│  └── index.tsx
└── _layout.tsx # Top level context wrapper

Pages and Layouts​

_layout.tsx​

Top level context wrapper for the Run Computation Task Flow.

Customizable items​

  • Index page data source
  • Index page data source unique ID field
  • Index page columns
  • Inputs page data table unique ID field
  • Inputs page columns
  • Results page data table unique ID field
  • Results page columns

_layout/index.tsx​

First page of the Run Computation Task Flow. Displays a list of existing runs and a button to create a new run.

Customizable items​

  • List page title
  • List page description
  • New scenario button
  • NewScenarioModal.tsx
    • New item modal title
    • New item form components

_layout/$id/_layout.tsx​

Layout wrapper for the inner Run Computation steps. Includes a breadcrumb bar at the top of the page.

Customizable items​

  • Breadcrumb link
  • Breadcrumb label

_layout/$id/_layout/data-inputs.tsx​

Data inputs page of the Run Computation Task Flow. The first step in a computation which displays a set of input data for the computation.

Customizable items​

  • Inputs table data source

_layout/$id/_layout/settings.tsx​

Settings page of the Run Computation Task Flow. Displays a form for editing parameters to pass to the computation when it runs.

Customizable items​

  • Settings page title
  • Settings form elements
  • Run button

_layout/$id/_layout/running.tsx​

Running page of the Run Computation Task Flow. Displays a progress bar and message while the computation is in progress.

Customizable items​

  • In progress section title
  • In progress section description

_layout/$id/_layout/results.tsx​

Results page of the Run Computation Task Flow. Displays output data and visualizations from the computation.

Customizable items​

  • Results table data source
  • Results line chart data source
  • Results bar chart data source
  • Back to settings button