fee-lab-to-nwb

将麻省理工学院Fee实验室的数据转换为Neurodata Without Borders数据格式的脚本。

克隆和安装

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

在终端（注意conda应该在您的系统中安装）中，您可以执行以下操作

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

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

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

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

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

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

pip install fee-lab-to-nwb

仓库结构

每个转换都在src目录下的一个独立目录中组织

fee-lab-to-nwb/
├── LICENSE
├── make_env.yml
├── pyproject.toml
├── README.md
├── requirements.txt
├── setup.py
└── src
    ├── fee_lab_to_nwb
    │   ├── general_interfaces
    │   └── scherrer_ophys
    │       ├── convert_session.py
    │       ├── metadata.yml
    │       ├── notes.md
    │       ├── requirements.txt
    │       ├── scherrerophysimagingextractor.py
    │       ├── scherrerophysimaginginterface.py
    │       ├── scherrerophysnwbconverter.py
    │       └── __init__.py

    └── __init__.py

对于scherrer_ophys转换，您可以在src/fee-lab-to-nwb/scherrer_ophys目录中找到它。在转换目录中，您可以找到以下文件

• convert_session.py：这是执行完整转换所必需的中央脚本。
• metadata.yml：特定转换的yaml格式元数据。
• notes.md：关于源数据的注释和说明。
• requirements.txt：特定转换的依赖项。

其他必要的特定转换文件

• scherrerophysimagingextractor.py：单个ophys文件的提取器。
• scherrerophysimaginginterface.py：该ophys数据集的接口。
• scherrerophysnwbconverter.py：定义NWBConverter类的地方。

该目录可能包含其他必要的转换文件，但这些都是核心文件。

运行特定转换

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

pip install -r src/fee_lab_to_nwb/scherrer_ophys/requirements.txt

您可以使用以下命令运行特定转换

python src/fee_lab_to_nwb/scherrer_ophys/convert_session.py

请注意，当从pip安装fee-lab-to-nwb时，转换脚本将位于pip安装站点包的任何位置。在这种情况下，您需要手动复制/粘贴使用脚本到您想要使用它们的位置。

转换过程中的问题

如果在转换过程中遇到任何问题，请打开一个问题，我们将帮助您！