Skip to content

on_boarding.md

Latest commit

 

History

History
156 lines (105 loc) · 14.7 KB

on_boarding.md

File metadata and controls

156 lines (105 loc) · 14.7 KB
graph LR
    Data_Access_Caching_Layer["Data Access & Caching Layer"]
    Core_Data_Objects_Utilities["Core Data Objects & Utilities"]
    Brain_Observatory_Data_Analysis["Brain Observatory Data & Analysis"]
    Electrophysiology_Data_Analysis["Electrophysiology Data & Analysis"]
    Neuronal_Modeling_Frameworks["Neuronal Modeling Frameworks"]
    Internal_Pipeline_Data_Release_Tools["Internal Pipeline & Data Release Tools"]
    Visualization_Plotting["Visualization & Plotting"]
    Configuration_Schema_Management["Configuration & Schema Management"]
    Brain_Structure_Connectivity["Brain Structure & Connectivity"]
    Data_Access_Caching_Layer -- "provides data to" --> Core_Data_Objects_Utilities
    Data_Access_Caching_Layer -- "is configured by" --> Configuration_Schema_Management
    Core_Data_Objects_Utilities -- "receives data from" --> Data_Access_Caching_Layer
    Core_Data_Objects_Utilities -- "provides foundation for" --> Brain_Observatory_Data_Analysis
    Brain_Observatory_Data_Analysis -- "consumes data from" --> Data_Access_Caching_Layer
    Brain_Observatory_Data_Analysis -- "relies on" --> Core_Data_Objects_Utilities
    Electrophysiology_Data_Analysis -- "consumes data from" --> Data_Access_Caching_Layer
    Electrophysiology_Data_Analysis -- "relies on" --> Core_Data_Objects_Utilities
    Neuronal_Modeling_Frameworks -- "consumes data from" --> Data_Access_Caching_Layer
    Neuronal_Modeling_Frameworks -- "relies on" --> Core_Data_Objects_Utilities
    Internal_Pipeline_Data_Release_Tools -- "consumes data from" --> Brain_Observatory_Data_Analysis
    Internal_Pipeline_Data_Release_Tools -- "utilizes" --> Data_Access_Caching_Layer
    Visualization_Plotting -- "consumes data from" --> Brain_Observatory_Data_Analysis
    Visualization_Plotting -- "provides output to" --> Internal_Pipeline_Data_Release_Tools
    Configuration_Schema_Management -- "configures/validates" --> Data_Access_Caching_Layer
    Configuration_Schema_Management -- "configures/validates" --> Brain_Observatory_Data_Analysis
    Brain_Structure_Connectivity -- "consumes data from" --> Data_Access_Caching_Layer
    Brain_Structure_Connectivity -- "provides context for" --> Brain_Observatory_Data_Analysis
    click Data_Access_Caching_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Data_Access_Caching_Layer.md" "Details"
    click Core_Data_Objects_Utilities href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Core_Data_Objects_Utilities.md" "Details"
    click Brain_Observatory_Data_Analysis href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Brain_Observatory_Data_Analysis.md" "Details"
    click Electrophysiology_Data_Analysis href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Electrophysiology_Data_Analysis.md" "Details"
    click Neuronal_Modeling_Frameworks href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Neuronal_Modeling_Frameworks.md" "Details"
    click Internal_Pipeline_Data_Release_Tools href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Internal_Pipeline_Data_Release_Tools.md" "Details"
    click Configuration_Schema_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Configuration_Schema_Management.md" "Details"
    click Brain_Structure_Connectivity href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AllenSDK/Brain_Structure_Connectivity.md" "Details"
Loading

CodeBoardingDemoContact

Details

The AllenSDK is structured as a comprehensive Neuroinformatics Software Development Kit, designed to facilitate neuroscience research through modular, data-centric, and extensible components. The architecture emphasizes clear separation of concerns, robust data access, and domain-specific analysis capabilities, all underpinned by a strong foundation of core utilities and configuration management.

Data Access & Caching Layer [Expand]

This foundational layer provides unified and efficient access to various Allen Institute neuroscience datasets (experimental data, metadata, reference spaces). It integrates robust caching mechanisms (local and S3-based) to optimize data retrieval from cloud storage and internal data warehouses (LIMS, Mtrain).

Related Classes/Methods:

Core Data Objects & Utilities [Expand]

This component defines fundamental data structures, common utility functions (e.g., for JSON, H5, pickle serialization), and base classes for all data objects within the SDK. It ensures data consistency, facilitates interoperability, and integrates with NWB (Neurodata Without Borders) data standards.

Related Classes/Methods:

Brain Observatory Data & Analysis [Expand]

Specialized component for processing, analyzing, and managing data from Brain Observatory experiments (calcium imaging and behavioral data). Includes tools for data loading, preprocessing (motion correction, dFF), stimulus-response analysis, and NWB export.

Related Classes/Methods:

Electrophysiology Data & Analysis [Expand]

Provides a comprehensive suite of tools for processing, analyzing, and managing electrophysiology (ephys) data. Functionalities include spike sorting, LFP analysis, current source density estimation, and NWB export for ephys datasets.

Related Classes/Methods:

Neuronal Modeling Frameworks [Expand]

Offers tools for constructing, optimizing, and simulating various neuronal models, including complex biophysical models (leveraging NEURON) and simplified GLIF models, enabling exploration of neuronal dynamics.

Related Classes/Methods:

Internal Pipeline & Data Release Tools [Expand]

Internal-facing modules and utilities for automating data processing pipelines, performing quality control, and preparing processed data and associated metadata for public release. Includes metadata writing and data copying.

Related Classes/Methods:

  • allensdk.internal.pipeline_modules
  • allensdk.brain_observatory.behavior.behavior_project_cache.project_metadata_writer
  • allensdk.brain_observatory.ecephys.write_nwb
  • allensdk.brain_observatory.ecephys.copy_utility

Visualization & Plotting

Collection of specialized tools and functions for generating various plots and visualizations of neuroscience data, aiding researchers in data exploration, quality control, and effective presentation.

Related Classes/Methods:

Configuration & Schema Management [Expand]

Manages the SDK's overall application configuration, including parsing command-line arguments, integrating environment variables, and defining/validating data schemas using argschema. Ensures consistent input/output formats and parameter handling.

Related Classes/Methods:

Brain Structure & Connectivity [Expand]

Offers tools and data structures for working with brain anatomy, standardized reference spaces, and mouse connectivity data. Enables spatial analysis and visualization of neural data within a consistent anatomical context.

Related Classes/Methods:

FAQ