Added documentation urls (#3437)

Co-authored-by: Daniel Chang <[email protected]>

packages/client/hmi-client/src/components/drilldown/tera-drilldown-header.vue

@@ -3,7 +3,9 @@
  <div class="title-row">
  <h4><slot /> <i v-if="props.tooltip" v-tooltip="tooltip" class="pi pi-info-circle" /></h4>
  <slot name="inputs" />
- <!-- <a :href="documentationUrl" rel="noopener noreferrer">Documentation</a> -->
+ <a v-if="documentationUrl" :href="documentationUrl" rel="noopener noreferrer"
+ >Documentation</a
+ >
  <Button
  class="close-mask"
  icon="pi pi-times"

packages/client/hmi-client/src/components/drilldown/tera-drilldown.vue

@@ -5,6 +5,7 @@
  :active-index="selectedViewIndex"
  :views="views"
  :tooltip="tooltip"
+ :documentation-url="node.documentationUrl"
  @tab-change="handleTabChange"
  @close="emit('on-close-clicked')"
  >

packages/client/hmi-client/src/components/workflow/ops/calibrate-ciemss/calibrate-operation.ts

@@ -1,6 +1,9 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 import { CalibrateMap } from '@/services/calibrate-workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/ciemss/pyciemss/blob/main/pyciemss/interfaces.py#L529';
+
 export interface CalibrationOperationStateCiemss extends BaseState {
  chartConfigs: string[][];
  mapping: CalibrateMap[];
@@ -22,6 +25,7 @@ export const CalibrationOperationCiemss: Operation = {
  displayName: 'Calibrate with PyCIEMSS',
  description:
  'given a model id, a dataset id, and optionally a configuration. calibrate the models initial values and rates',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'modelConfigId', label: 'Model configuration' },
  { type: 'datasetId', label: 'Dataset' }

packages/client/hmi-client/src/components/workflow/ops/calibrate-ensemble-ciemss/calibrate-ensemble-ciemss-operation.ts

@@ -1,6 +1,9 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 import type { EnsembleModelConfigs } from '@/types/Types';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/ciemss/pyciemss/blob/main/pyciemss/interfaces.py#L156';
+
 export interface EnsembleCalibrateExtraCiemss {
  solverMethod: string;
  numParticles: number; // The number of particles to use for the inference algorithm. https://github.com/ciemss/pyciemss/blob/1fc62b0d4b0870ca992514ad7a9b7a09a175ce44/pyciemss/interfaces.py#L225
@@ -22,6 +25,7 @@ export const CalibrateEnsembleCiemssOperation: Operation = {
  name: WorkflowOperationTypes.CALIBRATE_ENSEMBLE_CIEMSS,
  displayName: 'Calibrate ensemble',
  description: '',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'datasetId', label: 'Dataset' },
  { type: 'modelConfigId', label: 'Model configuration', acceptMultiple: false }

packages/client/hmi-client/src/components/workflow/ops/calibrate-julia/calibrate-operation.ts

@@ -1,5 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/DARPA-ASKEM/sciml-service/blob/main/src/operations.jl#L245';
+
 export interface CalibrateMap {
  modelVariable: string;
  datasetVariable: string;
@@ -35,6 +38,7 @@ export const CalibrationOperationJulia: Operation = {
  displayName: 'Calibrate with SciML',
  description:
  'given a model id, a dataset id, and optionally a configuration. calibrate the models initial values and rates',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'modelConfigId', label: 'Model configuration' },
  { type: 'datasetId', label: 'Dataset' }

packages/client/hmi-client/src/components/workflow/ops/dataset-transformer/dataset-transformer-operation.ts

@@ -1,5 +1,7 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL = 'https://pandas.pydata.org/docs/user_guide/index.html#user-guide';
+
 export interface DatasetTransformerState extends BaseState {
  datasetId: string | null;
  notebookSessionId?: string;
@@ -8,6 +10,7 @@ export interface DatasetTransformerState extends BaseState {
 export const DatasetTransformerOperation: Operation = {
  name: WorkflowOperationTypes.DATASET_TRANSFORMER,
  description: 'Select a dataset',
+ documentationUrl: DOCUMENTATION_URL,
  displayName: 'Transform dataset',
  isRunnable: true,
  inputs: [{ type: 'datasetId|simulationId', label: 'Dataset or Simulation' }],

packages/client/hmi-client/src/components/workflow/ops/funman/funman-operation.ts

@@ -1,6 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 import type { FunmanInterval, TimeSpan } from '@/types/Types';
 
+const DOCUMENTATION_URL = 'https://github.com/siftech/funman';
+
 export interface ConstraintGroup {
  borderColour: string;
  name: string;
@@ -38,6 +40,7 @@ export const FunmanOperation: Operation = {
  name: WorkflowOperationTypes.FUNMAN,
  displayName: 'Validate configuration',
  description: 'Validate configuration',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [{ type: 'modelConfigId', label: 'Model configuration', acceptMultiple: false }],
  outputs: [{ type: 'funmanQueryId' }],
  isRunnable: true,

packages/client/hmi-client/src/components/workflow/ops/model-comparison/model-comparison-operation.ts

@@ -1,6 +1,9 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 import { NotebookHistory } from '@/services/notebook';
 
+const DOCUMENTATION_URL =
+ 'https://githubicom/gyorilab/mira/blob/7314765ab409ddc9647269ad2381055f1cd67706/notebooks/hackathon_2023.10/dkg_grounding_model_comparison.ipynb#L307';
+
 export interface ModelComparisonOperationState extends BaseState {
  notebookHistory: NotebookHistory[];
  hasCodeRun: boolean;
@@ -11,6 +14,7 @@ export const ModelComparisonOperation: Operation = {
  name: WorkflowOperationTypes.MODEL_COMPARISON,
  displayName: 'Compare models',
  description: '',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'modelId', label: 'Model' },
  { type: 'modelId', label: 'Model' }

packages/client/hmi-client/src/components/workflow/ops/model-coupling/model-coupling-operation.ts

@@ -1,12 +1,16 @@
 import type { Operation, BaseState } from '@/types/workflow';
 import { WorkflowOperationTypes } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://algebraicjulia.github.io/Decapodes.jl/dev/overview/#Merging-Multiple-Physics';
+
 export interface ModelCouplingState extends BaseState {}
 
 export const ModelCouplingOperation: Operation = {
  name: WorkflowOperationTypes.MODEL_COUPLING,
  description: 'Couple models',
  displayName: 'Couple models',
+ documentationUrl: DOCUMENTATION_URL,
  isRunnable: true,
  inputs: [{ type: 'modelId', label: 'Model' }],
  outputs: [],

packages/client/hmi-client/src/components/workflow/ops/model-edit/model-edit-operation.ts

@@ -1,5 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/DARPA-ASKEM/beaker-kernel/blob/main/docs/contexts_mira_model_edit.md';
+
 export interface ModelEditCode {
  code: string;
  timestamp: number;
@@ -14,6 +17,7 @@ export const ModelEditOperation: Operation = {
  name: WorkflowOperationTypes.MODEL_EDIT,
  displayName: 'Edit model',
  description: 'Edit a model',
+ documentationUrl: DOCUMENTATION_URL,
  isRunnable: false,
  inputs: [
  { type: 'modelId|modelConfigId', label: 'Model or Model configuration', acceptMultiple: false }

packages/client/hmi-client/src/components/workflow/ops/model-from-code/model-from-code-operation.ts

@@ -3,6 +3,8 @@ import { ModelServiceType } from '@/types/common';
 import { AssetBlock, Operation, WorkflowOperationTypes } from '@/types/workflow';
 import { CodeBlock } from '@/utils/code-asset';
 
+const DOCUMENTATION_URL = 'https://github.com/ml4ai/ASKEM-TA1-DockerVM?tab=readme-ov-file#code2amr';
+
 export interface ModelFromCodeState {
  codeLanguage: ProgrammingLanguage;
  codeBlocks: AssetBlock<CodeBlock>[];
@@ -15,6 +17,7 @@ export const ModelFromCodeOperation: Operation = {
  name: WorkflowOperationTypes.MODEL_FROM_CODE,
  description: 'Create model',
  displayName: 'Create model from code',
+ documentationUrl: DOCUMENTATION_URL,
  isRunnable: true,
  inputs: [
  { type: 'codeAssetId', label: 'Code' },

packages/client/hmi-client/src/components/workflow/ops/model-from-equations/model-from-equations-operation.ts

@@ -2,6 +2,9 @@ import type { DocumentExtraction } from '@/types/Types';
 import { ModelServiceType } from '@/types/common';
 import { AssetBlock, Operation, WorkflowOperationTypes } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/DARPA-ASKEM/model-service/blob/07ae21cae2d5465f9ac5b5bbbe6c7b28b7259f04/src/ModelService.jl#L54';
+
 export interface EquationBlock {
  text: string;
  extractionError?: boolean;
@@ -29,6 +32,7 @@ export const ModelFromEquationsOperation: Operation = {
  name: WorkflowOperationTypes.MODEL_FROM_EQUATIONS,
  description: 'Create model from equations',
  displayName: 'Create model from equations',
+ documentationUrl: DOCUMENTATION_URL,
  isRunnable: true,
  inputs: [{ type: 'documentId', label: 'Document' }],
  outputs: [],

packages/client/hmi-client/src/components/workflow/ops/optimize-ciemss/optimize-ciemss-operation.ts

@@ -1,5 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/ciemss/pyciemss/blob/main/pyciemss/interfaces.py#L747';
+
 export enum InterventionTypes {
  paramValue = 'param_value',
  startTime = 'start_time'
@@ -65,6 +68,7 @@ export const OptimizeCiemssOperation: Operation = {
  name: WorkflowOperationTypes.OPTIMIZE_CIEMSS,
  displayName: 'Optimize with PyCIEMSS',
  description: 'Optimize with PyCIEMSS',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'modelConfigId', label: 'Model configuration', acceptMultiple: false },
  { type: 'calibrateSimulationId', label: 'Calibration', acceptMultiple: false, isOptional: true }

packages/client/hmi-client/src/components/workflow/ops/regridding/regridding-operation.ts

@@ -1,5 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/DARPA-ASKEM/beaker-kernel/blob/main/docs/contexts_climate_data_utility.md';
+
 export interface RegriddingOperationState extends BaseState {
  datasetId: string | null;
  notebookSessionId?: string;
@@ -9,6 +12,7 @@ export const RegriddingOperation: Operation = {
  name: WorkflowOperationTypes.REGRIDDING,
  description: 'Select a dataset',
  displayName: 'Transform gridded dataset',
+ documentationUrl: DOCUMENTATION_URL,
  isRunnable: true,
  inputs: [{ type: 'datasetId', label: 'Dataset' }],
  outputs: [],

packages/client/hmi-client/src/components/workflow/ops/simulate-ciemss/simulate-ciemss-operation.ts

@@ -1,6 +1,9 @@
 import type { TimeSpan } from '@/types/Types';
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/ciemss/pyciemss/blob/main/pyciemss/interfaces.py#L323';
+
 export interface SimulateCiemssOperationState extends BaseState {
  // state shared across all runs
  chartConfigs: string[][];
@@ -20,6 +23,7 @@ export const SimulateCiemssOperation: Operation = {
  name: WorkflowOperationTypes.SIMULATE_CIEMSS,
  displayName: 'Simulate with PyCIEMSS',
  description: 'given a model id, and configuration id, run a simulation',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'modelConfigId', label: 'Model configuration', acceptMultiple: false },
  { type: 'calibrateSimulationId', label: 'Calibration', acceptMultiple: false, isOptional: true }

packages/client/hmi-client/src/components/workflow/ops/simulate-ensemble-ciemss/simulate-ensemble-ciemss-operation.ts

@@ -1,6 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 import type { EnsembleModelConfigs, TimeSpan } from '@/types/Types';
 
+const DOCUMENTATION_URL = 'https://github.com/ciemss/pyciemss/blob/main/pyciemss/interfaces.py#L35';
+
 export interface SimulateEnsembleCiemssOperationState extends BaseState {
  chartConfigs: string[][];
  mapping: EnsembleModelConfigs[];
@@ -14,6 +16,7 @@ export const SimulateEnsembleCiemssOperation: Operation = {
  name: WorkflowOperationTypes.SIMULATE_ENSEMBLE_CIEMSS,
  displayName: 'Simulate ensemble',
  description: '',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [{ type: 'modelConfigId', label: 'Model configuration', acceptMultiple: false }],
  outputs: [{ type: 'simulationId' }],
  isRunnable: true,

packages/client/hmi-client/src/components/workflow/ops/simulate-julia/simulate-julia-operation.ts

@@ -1,6 +1,9 @@
 import type { TimeSpan } from '@/types/Types';
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/DARPA-ASKEM/sciml-service/blob/main/src/operations.jl#L222';
+
 export interface SimulateJuliaOperationState extends BaseState {
  // state shared across all runs
  chartConfigs: string[][];
@@ -16,6 +19,7 @@ export const SimulateJuliaOperation: Operation = {
  name: WorkflowOperationTypes.SIMULATE_JULIA,
  displayName: 'Simulate with SciML',
  description: 'given a model id, and configuration id, run a simulation',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [{ type: 'modelConfigId', label: 'Model configuration', acceptMultiple: false }],
  outputs: [{ type: 'simulationId' }],
  isRunnable: true,

packages/client/hmi-client/src/components/workflow/ops/stratify-mira/stratify-mira-operation.ts

@@ -1,6 +1,9 @@
 import type { Operation, BaseState } from '@/types/workflow';
 import { WorkflowOperationTypes } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/gyorilab/mira/blob/main/notebooks/viz_strat_petri.ipynb';
+
 export interface StratifyGroup {
  borderColour: string;
  name: string;
@@ -53,6 +56,7 @@ export const StratifyMiraOperation: Operation = {
  name: WorkflowOperationTypes.STRATIFY_MIRA,
  displayName: 'Stratify model',
  description: 'Stratify a model',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [
  { type: 'modelId|modelConfigId', label: 'Model or Model configuration', acceptMultiple: false }
  ],

packages/client/hmi-client/src/components/workflow/ops/subset-data/subset-data-operation.ts

@@ -1,5 +1,8 @@
 import { Operation, WorkflowOperationTypes, BaseState } from '@/types/workflow';
 
+const DOCUMENTATION_URL =
+ 'https://github.com/DARPA-ASKEM/climate-data/blob/main/api/processing/filters.py#L48';
+
 export interface SubsetDataOperationState extends BaseState {
  datasetId: string | null;
  fromDate: Date;
@@ -20,6 +23,7 @@ export const SubsetDataOperation: Operation = {
  name: WorkflowOperationTypes.SUBSET_DATA,
  displayName: 'Subset dataset',
  description: '',
+ documentationUrl: DOCUMENTATION_URL,
  inputs: [{ type: 'datasetId', label: 'Dataset' }],
  outputs: [{ type: 'datasetId' }],
  isRunnable: true,

packages/client/hmi-client/src/services/workflow.ts

@@ -69,6 +69,7 @@ export const addNode = (
  workflowId: wf.id,
  operationType: op.name,
  displayName: op.displayName,
+ documentationUrl: op.documentationUrl,
  x: pos.x,
  y: pos.y,
  state: options.state ?? {},

packages/client/hmi-client/src/types/workflow.ts

@@ -59,6 +59,7 @@ export interface Operation {
  name: WorkflowOperationTypes;
  description: string;
  displayName: string; // Human-readable name for each node.
+ documentationUrl?: string;
 
  // The operation is self-runnable, that is, given just the inputs we can derive the outputs
  isRunnable: boolean;
@@ -106,6 +107,7 @@ export interface WorkflowNode<S> {
  displayName: string;
  workflowId: string;
  operationType: WorkflowOperationTypes;
+ documentationUrl?: string;
 
  // Position on canvas
  x: number;