ahrens-lab-to-nwb

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

克隆和安装

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

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

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

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

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

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

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

仓库结构

每次转换都组织在其自己的目录中，位于src目录下。

ahrens-lab-to-nwb/
├── LICENSE
├── make_env.yml
├── pyproject.toml
├── README.md
├── requirements.txt
├── setup.py
└── src
    ├── ahrens_lab_to_nwb
    │   ├── conversion_directory_1
    │   └── yu_mu_cell_2019`
    │       ├── yu_mu_cell_2019behaviorinterface.py
    │       ├── yu_mu_cell_2019_convert_script.py
    │       ├── yu_mu_cell_2019_metadata.yml
    │       ├── yu_mu_cell_2019nwbconverter.py
    │       ├── yu_mu_cell_2019_requirements.txt
    │       ├── yu_mu_cell_2019_notes.md

    │       └── __init__.py
    │   ├── conversion_directory_b

    └── __init__.py

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

• yu_mu_cell_2019_convert_script.py：这是必须运行的中央脚本，以执行完整的转换。
• yu_mu_cell_2019_requirements.txt：特定于本次转换的依赖项。
• yu_mu_cell_2019_metadata.yml：本次特定转换的yaml格式元数据。
• yu_mu_cell_2019behaviorinterface.py：行为接口。通常针对每个转换定制。
• yu_mu_cell_2019nwbconverter.py：定义NWBConverter类的位置。
• yu_mu_cell_2019_notes.md：有关本次特定转换的注释和说明。

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

运行特定转换

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

pip install -r src/ahrens_lab_to_nwb/yu_mu_cell_2019/yu_mu_cell_2019_requirements.txt

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

python src/ahrens_lab_to_nwb/yu_mu_cell_2019/yu_mu_cell_2019_conversion_script.py