murthy-lab-to-nwb

Murthy实验室数据到Neurodata Without Borders数据格式的转换脚本。

克隆和安装

运行转换需要一些基本工具： python, git 和 pip。对于大多数用户，我们推荐您安装 conda (安装说明)，因为它包含所有必需的工具，并且安装简单。如果您使用的是Windows系统，可能还需要安装 git (安装说明) 以与此存储库交互。

从终端（请注意，conda应在您的系统中安装一个）您可以进行以下操作

git clone https://github.com/catalystneuro/murthy-lab-to-nwb
cd murthy-lab-to-nwb
conda env create --file make_env.yml
conda activate murthy-lab-to-nwb-env

这创建了一个conda环境，它将转换从您的系统中隔离出来。我们建议您从这个环境中运行所有与转换相关的任务和分析，以最大限度地减少此代码与您自己的系统的干扰。

如果您想完全避免使用conda（例如，如果您使用其他虚拟环境工具），可以使用以下命令仅使用pip安装存储库

git clone https://github.com/catalystneuro/murthy-lab-to-nwb
cd murthy-lab-to-nwb
pip install -e .

注意：上述两种方法都将存储库安装在可编辑模式中

Pip安装

您还可以使用pip安装软件包的最新版本

pip install murthy-lab-to-nwb

存储库结构

每个转换都在src目录下的自己的目录中组织

murthy-lab-to-nwb/
├── LICENSE
├── make_env.yml
├── pyproject.toml
├── README.md
├── requirements.txt
├── setup.py
└── src
    ├── __init__.py
    └── murthy_lab_to_nwb
        ├── __init__.py
        ├── cowley2022mapping
        │   ├── cowley2022mapping_courtship_convert_session.py
        │   ├── cowley2022mapping_imaging_convert_session.py
        │   ├── cowley2022mapping_nwbconverter.py
        │   ├── cowley2022mapping_requirements.txt
        │   ├── __init__.py
        │   ├── interfaces
        │   ├── metadata
        │   ├── utils
        │   ├── widget_demostration_courtship.ipynb
        │   └── widget_demostration_imaging.ipynb
        └── li2022ecephys
            ├── __init__.py
            ├── li2022ecephys_convert_session.py
            ├── li2022ecephysinterface.py
            ├── li2022ecephysnwbconverter.py
            └── li2022ecephys.yaml_.py
            └── __init__.py

例如，对于转换cowley2022mapping，您可以在src/murthy-lab-to-nwb/cowley2022mapping找到相应的目录。在每个转换目录中，您可以找到以下文件

• cowley2022mapping_courtship_convert_session.py：运行婚配会话的nwb转换。
• cowley2022mapping_imaging_convert_session.py：运行成像会话的nwb转换。
• cowley2022mapping_requirements.txt：特定于此转换的依赖项。
• widget_demostration_courtship.ipynb：用于可视化婚配nwb文件的Jupyter笔记本。
• widget_demostration_imaging.ipynb：用于可视化成像nwb文件的Jupyter笔记本。

以及以下目录

• interfaces目录，包含此转换所需的接口。
• metadata目录，包含添加额外元数据的可编辑yaml元数据文件。
• utils目录，包含转换的杂项实用工具。

运行特定转换

要运行完整会话的特定转换，您可以在此处查看以下示例

python src/murthy_lab_to_nwb/cowley2022mapping/cowley2022mapping_courtship_convert_session.py
python src/murthy_lab_to_nwb/cowley2022mapping/cowley2022mapping_imaging_convert_session.py
python src/murthy_lab_to_nwb/li2022ecephys/li2022ecephys_convert_session.py

您可能需要首先安装位于每个转换目录中的特定转换依赖项

pip install -r src/murthy_lab_to_nwb/cowley2022mapping/cowley2022mapping_requirements.txt