diff --git a/src/software/automation_pipeline_developer.md b/src/software/automation_pipeline_developer.md index 8dd1448..aa68bdf 100644 --- a/src/software/automation_pipeline_developer.md +++ b/src/software/automation_pipeline_developer.md @@ -7,7 +7,7 @@ lang: en-US The Ephys/Imaging Automation Pipeline in BRAINCoGS main goals are: -+ Automate spike sorting and imaging segmentation for all recordings ++ Automate spike sorting and imaging segmentation for all recordings + Centralize/Standardize paths for Recording Data Storage + Unify & Register Ephys/Imaging Processing + Store processed data in BRAINCoGS Database (DJ) @@ -16,7 +16,7 @@ To accomplish this we developed three tools: + Ephys/Imaging Automation GUI (RecordingProcessJobGUI) + Recording Workflow management (Automatic_job directory in U19-pipeline_python ) -+ Collab reposiotries to handle Ephys/Imaging Processing (BrainCogsEphysSorters and BrainCogsImagingSegmentation ) ++ Collab reposiotries to handle Ephys/Imaging Processing (BrainCogsEphysSorters and BrainCogsImagingSegmentation ) ## Ephys/Imaging Automation GUI @@ -33,14 +33,14 @@ Workflow management is composed mainly by two classes that handles recordings an + Ephys recordings are composed by one or many independent probe electrophysiology recordings. Each probe recording correspond to a job in the workflow management + Calcium imaging recordings are composed by one or many independent field of views image stacks. Each field of view image stack correspond to a job in the workflow management. -The class that manages workflow at the recording level is (RecordingHandler) +The class that manages workflow at the recording level is (RecordingHandler)
Workflow manager diagam at the recording level
-### Main functions and variables in recording workflow manager +### Main functions and variables in recording workflow manager + **recording_status_dict** in (Params Config file): This dictionary defines status definitions and corresponding functions to execute. + **pipeline_handler_main** in (RecordingHandler): Main function in recording workflow @@ -48,9 +48,9 @@ The class that manages workflow at the recording level is (RecordingHandler): Python decorator for error handling. -+ **modality_preingestion** in (RecordingHandler): Main ingestion function from recording to recording_process tables. There are subcalls depending on modality of recording (ephys or imaging). ++ **modality_preingestion** in (RecordingHandler): Main ingestion function from recording to recording_process tables. There are subcalls depending on modality of recording (ephys or imaging). -#### Imaging preingestion main steps: +#### Imaging preingestion main steps: + **imaging_preingestion** in (RecordingHandler): Ingestion to recording_process table for an imaging recording. Get all FOVs (TIFF stacks) for the recording and assign a new job for each one with corresponding parameters fetched from selection done in automation GUI. **AcquiredTiff populate function** in (Imaging pipeline): Auxiliar script to call **populate_Imaging_AcquiredTiff** script in MATLAB. @@ -66,7 +66,7 @@ The class that manages workflow at the recording level is (RecordingHandler): Ingestion to recording_process table for an ephys recording. Get all probes for the recording and assign a new job for each one with corresponding parameters fetched from selection done in automation GUI. 1. Ingest **ephys_pipeline.EphysPipelineSession** table @@ -81,7 +81,7 @@ The class that manages workflow at the recording level is (Params Config file): This dictionary defines status definitions and corresponding functions to execute. + **pipeline_handler_main** in (RecProcessHandler): Main function in recording process workflow @@ -110,4 +110,4 @@ The class that manages workflow at the recording level is (