Enable ME-model circuit simulation (unified UI)

.env.development

@@ -2,8 +2,9 @@ KEYCLOAK_ISSUER=https://staging.openbraininstitute.org/auth/realms/SBO
 KEYCLOAK_CLIENT_ID=obp-core-web-app-dev
 KEYCLOAK_CLIENT_SECRET=dummy-secret
 
-NEXTAUTH_SECRET=dummy-secret-for-dev
+NEXT_PUBLIC_DEPLOYMENT_ENV=staging
 
+NEXTAUTH_SECRET=dummy-secret-for-dev
 
 NEXT_PUBLIC_BBS_ML_BASE_URL=https://staging.openbraininstitute.org/api/bbs-ml
 NEXT_PUBLIC_SMALL_SCALE_SIMULATOR_URL=https://staging.openbraininstitute.org/api/small-scale-simulator
@@ -26,8 +27,6 @@ NEXT_PUBLIC_DEFAULT_BRAIN_ATLAS_ID="b4b6bdd1-583c-4c8c-a215-28c269fef4fa"
 NEXT_PUBLIC_ROOT_BRAIN_REGION_ID="eb1167b3-67a9-4378-bc65-c1e582e2e662"
 NEXT_PUBLIC_ROOT_BRAIN_REGION_ANNOTATION_VALUE=997
 
-NEXT_PUBLIC_DEPLOYMENT_ENV="staging"
-
 # Entity Core service configuration
 NEXT_PUBLIC_ENTITY_CORE_URL=https://staging.openbraininstitute.org/api/entitycore
 NEXT_PUBLIC_ENTITY_CORE_PUBLIC_VIRTUAL_LAB_ID="a98b7abc-fc46-4700-9e3d-37137812c730"

src/api/entitycore/types/extended-entity-type.ts

@@ -5,6 +5,8 @@ export const ExtendedEntitiesTypeDict = {
   SmallMicrocircuit: 'small_micro_circuit',
   Microcircuit: 'micro_circuit',
   PairedNeuronCircuit: 'paired_neuron_circuit',
+  MemodelCircuit: 'me_model_circuit',
+  MemodelCircuitSimulation: 'me_model_circuit_simulation',
   PairedNeuronCircuitSimulation: 'paired_neuron_circuit_simulation',
   SmallMicrocircuitSimulation: 'small_microcircuit_simulation',
   MicrocircuitSimulation: 'micro_circuit_simulation',

src/app/app/layout.tsx

@@ -3,15 +3,18 @@ import { ReactNode, Suspense } from 'react';
 import { AppOnboardingProvider } from '@/ui/segments/app-setup/discover-app';
 import { Providers } from '@/app/app/providers';
 import { auth } from '@/auth';
+import { getAllFlags } from '@/features/feature-flags';
 
 type RootLayoutProps = {
   children: ReactNode;
 };
 
 export default async function AppLayout({ children }: RootLayoutProps) {
   const session = await auth();
+  const flags = await getAllFlags();
+
   return (
-    <Providers session={session}>
+    <Providers session={session} flags={flags}>
       <AppOnboardingProvider>
         <Suspense fallback={null}>{children}</Suspense>
       </AppOnboardingProvider>

src/app/app/providers.tsx

@@ -16,15 +16,17 @@ import { ProgressBarProvider } from '@/app/app/progress-provider';
 import { QueryProvider } from '@/query-provider/client';
 import { SessionOrNull } from '@/hooks/session';
 import { AtomProvider } from '@/state/state';
+import { FeatureFlags, FlagsProvider } from '@/features/feature-flags';
 
 import 'jotai-devtools/styles.css';
 
 type ProvidersProps = {
   children: ReactNode;
   session: SessionOrNull;
+  flags: FeatureFlags;
 };
 
-export function Providers({ children, session }: ProvidersProps) {
+export function Providers({ children, session, flags }: ProvidersProps) {
   return (
     <ConfigProvider theme={commonAntdTheme}>
       <App>
@@ -39,7 +41,9 @@ export function Providers({ children, session }: ProvidersProps) {
                   <ThemeProvider>
                     <SessionProvider session={session} refetchInterval={2 * 60}>
                       <SessionStateProvider>
-                        <ProgressBarProvider>{children}</ProgressBarProvider>
+                        <FlagsProvider flags={flags}>
+                          <ProgressBarProvider>{children}</ProgressBarProvider>
+                        </FlagsProvider>
                       </SessionStateProvider>
                     </SessionProvider>
                   </ThemeProvider>

src/app/app/virtual-lab/[virtualLabId]/[projectId]/data/(browse)/browse/entity/[type]/page.tsx

@@ -24,6 +24,7 @@ const AllowedEntities = [
   ExtendedEntitiesTypeDict.Memodel,
   ExtendedEntitiesTypeDict.Circuit,
   ExtendedEntitiesTypeDict.Emodel,
+  ExtendedEntitiesTypeDict.MemodelCircuitSimulation,
   ExtendedEntitiesTypeDict.SingleNeuronSynaptomeSimulation,
   ExtendedEntitiesTypeDict.PairedNeuronCircuitSimulation,
   ExtendedEntitiesTypeDict.SmallMicrocircuitSimulation,

src/app/app/virtual-lab/[virtualLabId]/[projectId]/data/view/[type]/[id]/layout.tsx

@@ -83,7 +83,8 @@ export default async function Layout({
 
   if (
     type === ExtendedEntitiesTypeDict.SmallMicrocircuitSimulation ||
-    type === ExtendedEntitiesTypeDict.PairedNeuronCircuitSimulation
+    type === ExtendedEntitiesTypeDict.PairedNeuronCircuitSimulation ||
+    type === ExtendedEntitiesTypeDict.MemodelCircuitSimulation
   ) {
     return (
       <div className="relative ml-5 flex h-full flex-col rounded-md border-[1px] border-[#D9D9D9] px-5 py-3">

src/app/app/virtual-lab/[virtualLabId]/[projectId]/workflows/simulate/configure/circuit/[id]/page.tsx

@@ -4,14 +4,14 @@ import { useQuery, useSuspenseQuery } from '@tanstack/react-query';
 import { notFound } from 'next/navigation';
 import { use } from 'react';
 
-import { resolveSimulationByCampaignId } from '@/entity-configuration/domain/simulation/small-microcircuit-simulation';
 import { getCircuit } from '@/api/entitycore/queries/model/circuit';
-import { keyBuilder } from '@/ui/use-query-keys/data';
+import { resolveSimulationByCampaignId } from '@/entity-configuration/domain/simulation/small-microcircuit-simulation';
 import SimulationConfig from '@/features/small-microcircuit';
+import { keyBuilder } from '@/ui/use-query-keys/data';
 
+import type { ServerSideComponentProp, WorkspaceContext } from '@/types/common';
 import type { WorkflowSimulatePanelKeys } from '@/ui/segments/workflows/simulate/single-neuron/shared/constant';
 import type { ExperimentStepKeys } from '@/ui/segments/workflows/simulate/single-neuron/shared/elements/menu';
-import type { ServerSideComponentProp, WorkspaceContext } from '@/types/common';
 
 export default function Page({
   searchParams,
@@ -64,7 +64,7 @@ export default function Page({
     return (
       <div className="border-neutral-2 ml-2 h-full rounded-2xl border pt-3">
         <SimulationConfig
-          circuitId={entity.id}
+          modelId={entity.id}
           virtualLabId={virtualLabId}
           projectId={projectId}
           initialConfig={campaignData?.config.form}

src/app/app/virtual-lab/[virtualLabId]/[projectId]/workflows/simulate/configure/memodel/[id]/page.tsx

@@ -18,8 +18,13 @@ import {
   type ThreeDVisualizerQueryParamKeys,
   type WorkflowSimulatePanelKeys,
 } from '@/ui/segments/workflows/simulate/single-neuron/shared/constant';
+import SimulationConfig from '@/features/small-microcircuit';
 import type { ExperimentStepKeys } from '@/ui/segments/workflows/simulate/single-neuron/shared/elements/menu';
 import type { ServerSideComponentProp, WorkspaceContext } from '@/types/common';
+import {
+  ExtendedEntitiesTypeDict,
+  TExtendedEntitiesTypeDict,
+} from '@/api/entitycore/types/extended-entity-type';
 
 export default function Page({
   searchParams,
@@ -30,6 +35,7 @@ export default function Page({
     step: ExperimentStepKeys;
     sessionId: string;
     panel: WorkflowSimulatePanelKeys;
+    dataType: TExtendedEntitiesTypeDict;
     '3d': ThreeDVisualizerQueryParamKeys;
   }
 >) {
@@ -47,6 +53,17 @@ export default function Page({
     queryFn: () => getMEModel({ id: modelId, context: { virtualLabId, projectId } }),
   });
 
+  if (queryParams.dataType === ExtendedEntitiesTypeDict.MemodelCircuit) {
+    return (
+      <SimulationConfig
+        modelId={entity.id}
+        virtualLabId={virtualLabId}
+        projectId={projectId}
+        className="px-8 pt-1"
+      />
+    );
+  }
+
   return (
     <>
       <div className="mb-2 w-full flex-shrink-0">

src/entity-configuration/definitions/fields-defs/enums.ts

@@ -53,6 +53,7 @@ export enum EntityCoreFields {
   EModelScore = 'eModelScore',
   EModelResponse = 'eModelResponse',
   MEModelMorphologyPreview = 'meModelMorphologyPreview',
+  MEModelName = 'meModelName',
   MEModelTracePreview = 'meModelTracePreview',
   MEModelValidationStatus = 'validation_status',
   SynaptomeUsedMEModelName = 'me_model',

src/entity-configuration/definitions/fields-defs/experiment.tsx

@@ -251,4 +251,11 @@ export const FieldsDefinition: Partial<FieldsDefinitionRegistry<EntityCoreObject
     isDisplayable: true,
     isFilterable: false,
   },
+  [EntityCoreFields.MEModelName]: {
+    title: 'ME-model',
+    filter: null,
+    render: (r) => renderEmptyOrValue(get(r, 'memodel.name', '')),
+    isDisplayable: true,
+    isFilterable: false,
+  },
 };

src/entity-configuration/definitions/view-defs/experiment.ts

@@ -91,6 +91,37 @@ export const ViewsDefinition: { [key: string]: ViewDefinitionConfig } = {
       { field: EntityCoreFields.CreationDate },
     ],
   },
+  [ExtendedEntitiesTypeDict.MemodelCircuitSimulation]: {
+    title: 'Single neuron [circuit] simulation',
+    group: DataTypeGroup.SimulationData,
+    name: EntitySlug.MEModelCircuitSimulation,
+    curated: false,
+    columns: [
+      EntityCoreFields.Name,
+      EntityCoreFields.Description,
+      EntityCoreFields.CircuitName,
+      EntityCoreFields.SimulationCampaignStatus,
+      EntityCoreFields.CreatedBy,
+      EntityCoreFields.CreationDate,
+    ],
+    filterableFields: [
+      EntityCoreFields.Name,
+      EntityCoreFields.Contributions,
+      EntityCoreFields.CreatedBy,
+      EntityCoreFields.CreationDate,
+    ],
+    displayableFields: [
+      EntityCoreFields.Name,
+      EntityCoreFields.Contributions,
+      EntityCoreFields.CreatedBy,
+      EntityCoreFields.CreationDate,
+    ],
+    miniDetailView: [
+      { field: EntityCoreFields.CircuitName },
+      { field: EntityCoreFields.SimulationCampaignStatus },
+      { field: EntityCoreFields.CreationDate },
+    ],
+  },
   [ExtendedEntitiesTypeDict.PairedNeuronCircuitSimulation]: {
     title: 'Paired Neurons Simulation',
     group: DataTypeGroup.SimulationData,

src/entity-configuration/definitions/view-defs/model/index.ts

@@ -14,6 +14,7 @@ export const ViewsDefinition: { [key: string]: ViewDefinitionConfig } = {
   [ExtendedEntitiesTypeDict.Emodel]: ViewDefForEmodel,
   [ExtendedEntitiesTypeDict.Memodel]: ViewDefForMemodel,
   [ExtendedEntitiesTypeDict.SingleNeuronSynaptome]: ViewDefForSingleNeuronSynaptome,
+  [ExtendedEntitiesTypeDict.MemodelCircuit]: ViewDefForMemodel,
   [ExtendedEntitiesTypeDict.Circuit]: ViewDefForCircuit,
   [ExtendedEntitiesTypeDict.SmallMicrocircuit]: ViewDefForSmallMicrocircuit,
   [ExtendedEntitiesTypeDict.PairedNeuronCircuit]: ViewDefForPairedNeuronCircuit,

src/entity-configuration/definitions/view-defs/simulation/index.ts

@@ -3,6 +3,7 @@ import { viewDefForSingleNeuronSynaptomeSimulation } from './single-neuron-synap
 import { viewDefForSimulationCampaign } from './simulation-campaign';
 import { viewDefForPairedNeuronCircuitSimulation } from './paired-neuron-circuit-simulation';
 import { viewDefForSmallMicrocircuitSimulation } from './small-microcircuit-simulation';
+import { viewDefForMEModelCircuitSimulation } from './memodel-circuit-simulation';
 
 import { ExtendedEntitiesTypeDict } from '@/api/entitycore/types/extended-entity-type';
 
@@ -15,4 +16,5 @@ export const ViewsDefinition: { [key: string]: ViewDefinitionConfig } = {
   [ExtendedEntitiesTypeDict.SimulationCampaign]: viewDefForSimulationCampaign,
   [ExtendedEntitiesTypeDict.PairedNeuronCircuitSimulation]: viewDefForPairedNeuronCircuitSimulation,
   [ExtendedEntitiesTypeDict.SmallMicrocircuitSimulation]: viewDefForSmallMicrocircuitSimulation,
+  [ExtendedEntitiesTypeDict.MemodelCircuitSimulation]: viewDefForMEModelCircuitSimulation,
 };

src/entity-configuration/definitions/view-defs/simulation/memodel-circuit-simulation.ts

@@ -0,0 +1,38 @@
+import {
+  DataTypeGroup,
+  type ViewDefinitionConfig,
+} from '@/entity-configuration/definitions/view-defs/types';
+import { EntitySlug } from '@/entity-configuration/domain/slug';
+import { EntityCoreFields } from '@/entity-configuration/definitions/fields-defs/enums';
+
+export const viewDefForMEModelCircuitSimulation: ViewDefinitionConfig = {
+  title: 'Single neuron [circuit] simulation',
+  group: DataTypeGroup.SimulationData,
+  name: EntitySlug.MEModelCircuitSimulation,
+  curated: false,
+  columns: [
+    EntityCoreFields.Name,
+    EntityCoreFields.Description,
+    EntityCoreFields.MEModelName,
+    EntityCoreFields.SimulationCampaignStatus,
+    EntityCoreFields.CreatedBy,
+    EntityCoreFields.CreationDate,
+  ],
+  filterableFields: [
+    EntityCoreFields.Name,
+    EntityCoreFields.Contributions,
+    EntityCoreFields.CreatedBy,
+    EntityCoreFields.CreationDate,
+  ],
+  displayableFields: [
+    EntityCoreFields.Name,
+    EntityCoreFields.Contributions,
+    EntityCoreFields.CreatedBy,
+    EntityCoreFields.CreationDate,
+  ],
+  miniDetailView: [
+    { field: EntityCoreFields.MEModelName },
+    { field: EntityCoreFields.SimulationCampaignStatus },
+    { field: EntityCoreFields.CreationDate },
+  ],
+};

src/entity-configuration/domain/index.ts

@@ -1,26 +1,28 @@
-import { SmallMicrocircuitSimulation } from '@/entity-configuration/domain/simulation/small-microcircuit-simulation';
-import { PairedNeuronCircuitSimulation } from '@/entity-configuration/domain/simulation/paired-neurons-simulation';
+import { BoutonDensity } from '@/entity-configuration/domain/experimental/bouton-density';
+import { CellMorphology } from '@/entity-configuration/domain/experimental/cell-morphology';
 import { ElectricalCellRecording } from '@/entity-configuration/domain/experimental/electrical-cell-recording';
-import { SynapsePerConnection } from '@/entity-configuration/domain/experimental/synapse-per-connection';
-import { MEModelWithSynapsesCircuit } from '@/entity-configuration/domain/model/me-model-with-synapses';
 import { IonChannelRecording } from '@/entity-configuration/domain/experimental/ion-channel-recording';
-import { SingleNeuronSynaptome } from '@/entity-configuration/domain/model/single-neuron-synaptome';
-import { CellMorphology } from '@/entity-configuration/domain/experimental/cell-morphology';
-import { SmallMicrocircuit } from '@/entity-configuration/domain/model/small-microcircuit';
 import { NeuronDensity } from '@/entity-configuration/domain/experimental/neuron-density';
-import { BoutonDensity } from '@/entity-configuration/domain/experimental/bouton-density';
-import { IonChannelModel } from '@/entity-configuration/domain/model/ion-channel-model';
-import { PairedNeuronCircuit } from '@/entity-configuration/domain/model/paired-neurons';
-import { Microcircuit } from '@/entity-configuration/domain/model/mirocircuit';
-import { MEmodel } from '@/entity-configuration/domain/model/me-model';
+import { SynapsePerConnection } from '@/entity-configuration/domain/experimental/synapse-per-connection';
 import { Circuit } from '@/entity-configuration/domain/model/circuit';
 import { Emodel } from '@/entity-configuration/domain/model/e-model';
+import { IonChannelModel } from '@/entity-configuration/domain/model/ion-channel-model';
+import { MEmodel } from '@/entity-configuration/domain/model/me-model';
+import { MEModelCircuit } from '@/entity-configuration/domain/model/me-model-circuit';
+import { MEModelWithSynapsesCircuit } from '@/entity-configuration/domain/model/me-model-with-synapses';
+import { Microcircuit } from '@/entity-configuration/domain/model/mirocircuit';
+import { PairedNeuronCircuit } from '@/entity-configuration/domain/model/paired-neurons';
+import { SingleNeuronSynaptome } from '@/entity-configuration/domain/model/single-neuron-synaptome';
+import { SmallMicrocircuit } from '@/entity-configuration/domain/model/small-microcircuit';
 import { Notebook } from '@/entity-configuration/domain/notebook';
 import {
+  SimulationCampaign,
   SingleNeuronSimulation,
   SingleNeuronSynaptomeSimulation,
-  SimulationCampaign,
 } from '@/entity-configuration/domain/simulation';
+import { MEModelCircuitSimulation } from '@/entity-configuration/domain/simulation/memodel-circuit-simulation';
+import { PairedNeuronCircuitSimulation } from '@/entity-configuration/domain/simulation/paired-neurons-simulation';
+import { SmallMicrocircuitSimulation } from '@/entity-configuration/domain/simulation/small-microcircuit-simulation';
 
 import type { EntityCoreTypeConfig } from '@/entity-configuration/domain/types';
 
@@ -36,6 +38,7 @@ export const EntityCoreExperimentalConfiguration = {
 export const EntityCoreModelConfiguration = {
   Emodel,
   MEmodel,
+  MEModelCircuit,
   SingleNeuronSynaptome,
   Circuit,
   SmallMicrocircuit,
@@ -49,6 +52,7 @@ const EntityCoreSimulationConfiguration = {
   SingleNeuronSimulation,
   SingleNeuronSynaptomeSimulation,
   SimulationCampaign,
+  MEModelCircuitSimulation,
   SmallMicrocircuitSimulation,
   PairedNeuronCircuitSimulation,
 };

src/entity-configuration/domain/model/index.ts

@@ -4,13 +4,15 @@ import { ExtendedEntitiesTypeDict } from '@/api/entitycore/types/extended-entity
 export const MODEL_DATATYPES = [
   ExtendedEntitiesTypeDict.Emodel,
   ExtendedEntitiesTypeDict.Memodel,
+  ExtendedEntitiesTypeDict.MemodelCircuit,
   ExtendedEntitiesTypeDict.SingleNeuronSynaptome,
   ExtendedEntitiesTypeDict.MEModelWithSynapses,
 ] as const;
 
 export enum ModelTypeNames {
   E_MODEL = 'e-model',
   ME_MODEL = 'me-model',
+  ME_MODEL_CIRCUIT = 'me-model-circuit',
   SINGLE_NEURON_SYNAPTOME = 'synaptome',
   ME_MODEL_WITH_SYNAPSES_CIRCUIT = 'ME-model with Synapses',
   CIRCUIT = 'circuit',