aind_data_transfer_service.configs package

Submodules

aind_data_transfer_service.configs.csv_handler module

Module to handle processing legacy csv files

aind_data_transfer_service.configs.csv_handler.create_nested_dict(dict_to_update: Dict[str, Any], key_string: str, value: Any) → None

Updates in-place a nested dictionary with a period delimited key and value.

Parameters:

  • dict_to_update (Dict[str, Any])

  • key_string (str)

  • value (Any)

aind_data_transfer_service.configs.csv_handler.map_csv_row_to_job(row: dict) → UploadJobConfigsV2

Maps csv row into a UploadJobConfigsV2 model. This attempts to be somewhat backwards compatible with previous csv files. :param row: :type row: dict

Return type:

UploadJobConfigsV2

aind_data_transfer_service.configs.csv_handler.nested_update(dict_to_update: Dict[str, Any], updates: Mapping) → Dict[str, Any]

Update a nested dictionary in-place.

Parameters:

  • dict_to_update (Dict[str, Any])

  • updates (Mapping)

Return type:

Dict[str, Any]

aind_data_transfer_service.configs.job_upload_template module

Module to configure and create xlsx job upload template

class aind_data_transfer_service.configs.job_upload_template.JobUploadTemplate

Bases: BaseModel

Class to configure and create xlsx job upload template

FILE_NAME: ClassVar[str] = 'job_upload_template.xlsx'
classmethod create_excel_sheet_filestream() → BytesIO

Create job template as xlsx filestream

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

aind_data_transfer_service.configs.platforms_v1 module

Platforms. We can remove this once aind-data-schema is adopted 100%

class aind_data_transfer_service.configs.platforms_v1.Platform

Bases: object

Platforms

ALL = (<class 'aind_data_transfer_service.configs.platforms_v1._Behavior'>, <class 'aind_data_transfer_service.configs.platforms_v1._Confocal'>, <class 'aind_data_transfer_service.configs.platforms_v1._Ecephys'>, <class 'aind_data_transfer_service.configs.platforms_v1._Exaspim'>, <class 'aind_data_transfer_service.configs.platforms_v1._Fip'>, <class 'aind_data_transfer_service.configs.platforms_v1._Hcr'>, <class 'aind_data_transfer_service.configs.platforms_v1._Hsfp'>, <class 'aind_data_transfer_service.configs.platforms_v1._Isi'>, <class 'aind_data_transfer_service.configs.platforms_v1._Merfish'>, <class 'aind_data_transfer_service.configs.platforms_v1._Mri'>, <class 'aind_data_transfer_service.configs.platforms_v1._Mesospim'>, <class 'aind_data_transfer_service.configs.platforms_v1._Motor_Observatory'>, <class 'aind_data_transfer_service.configs.platforms_v1._Multiplane_Ophys'>, <class 'aind_data_transfer_service.configs.platforms_v1._Slap2'>, <class 'aind_data_transfer_service.configs.platforms_v1._Single_Plane_Ophys'>, <class 'aind_data_transfer_service.configs.platforms_v1._Smartspim'>)
BEHAVIOR = _Behavior(name='Behavior platform', abbreviation='behavior')
CONFOCAL = _Confocal(name='Confocal microscopy platform', abbreviation='confocal')
ECEPHYS = _Ecephys(name='Electrophysiology platform', abbreviation='ecephys')
EXASPIM = _Exaspim(name='ExaSPIM platform', abbreviation='exaSPIM')
FIP = _Fip(name='Frame-projected independent-fiber photometry platform', abbreviation='FIP')
HCR = _Hcr(name='Hybridization chain reaction platform', abbreviation='HCR')
HSFP = _Hsfp(name='Hyperspectral fiber photometry platform', abbreviation='HSFP')
ISI = _Isi(name='Intrinsic signal imaging platform', abbreviation='ISI')
MERFISH = _Merfish(name='MERFISH platform', abbreviation='MERFISH')
MESOSPIM = _Mesospim(name='MesoSPIM platform', abbreviation='mesoSPIM')
MOTOR_OBSERVATORY = _Motor_Observatory(name='Motor observatory platform', abbreviation='motor-observatory')
MRI = _Mri(name='Magnetic resonance imaging platform', abbreviation='MRI')
MULTIPLANE_OPHYS = _Multiplane_Ophys(name='Multiplane optical physiology platform', abbreviation='multiplane-ophys')
ONE_OF

alias of _Behavior | _Confocal | _Ecephys | _Exaspim | _Fip | _Hcr | _Hsfp | _Isi | _Merfish | _Mri | _Mesospim | _Motor_Observatory | _Multiplane_Ophys | _Slap2 | _Single_Plane_Ophys | _Smartspim[_Behavior | _Confocal | _Ecephys | _Exaspim | _Fip | _Hcr | _Hsfp | _Isi | _Merfish | _Mri | _Mesospim | _Motor_Observatory | _Multiplane_Ophys | _Slap2 | _Single_Plane_Ophys | _Smartspim]

SINGLE_PLANE_OPHYS = _Single_Plane_Ophys(name='Single-plane optical physiology platform', abbreviation='single-plane-ophys')
SLAP2 = _Slap2(name='SLAP2 platform', abbreviation='SLAP2')
SMARTSPIM = _Smartspim(name='SmartSPIM platform', abbreviation='SmartSPIM')
abbreviation_map = {'FIP': _Fip(name='Frame-projected independent-fiber photometry platform', abbreviation='FIP'), 'HCR': _Hcr(name='Hybridization chain reaction platform', abbreviation='HCR'), 'HSFP': _Hsfp(name='Hyperspectral fiber photometry platform', abbreviation='HSFP'), 'ISI': _Isi(name='Intrinsic signal imaging platform', abbreviation='ISI'), 'MERFISH': _Merfish(name='MERFISH platform', abbreviation='MERFISH'), 'MRI': _Mri(name='Magnetic resonance imaging platform', abbreviation='MRI'), 'SLAP2': _Slap2(name='SLAP2 platform', abbreviation='SLAP2'), 'SmartSPIM': _Smartspim(name='SmartSPIM platform', abbreviation='SmartSPIM'), 'behavior': _Behavior(name='Behavior platform', abbreviation='behavior'), 'confocal': _Confocal(name='Confocal microscopy platform', abbreviation='confocal'), 'ecephys': _Ecephys(name='Electrophysiology platform', abbreviation='ecephys'), 'exaSPIM': _Exaspim(name='ExaSPIM platform', abbreviation='exaSPIM'), 'mesoSPIM': _Mesospim(name='MesoSPIM platform', abbreviation='mesoSPIM'), 'motor-observatory': _Motor_Observatory(name='Motor observatory platform', abbreviation='motor-observatory'), 'multiplane-ophys': _Multiplane_Ophys(name='Multiplane optical physiology platform', abbreviation='multiplane-ophys'), 'single-plane-ophys': _Single_Plane_Ophys(name='Single-plane optical physiology platform', abbreviation='single-plane-ophys')}
classmethod from_abbreviation(abbreviation: str)

Get platform from abbreviation

Module contents

Package to app configurations