np-aind-metadata

用法

conda create -n np_aind_metadata python>=3.10
conda activate np_aind_metadata
pip install np_aind_metadata

本地使用

如果在艾伦研究所内部，可以通过np-config使用额外的功能。要使用本地功能，请安装np-config。

pip install np-config

Python

本地

将存储中的最新rig.json从存储复制到本地路径。

>>> from datetime import datetime
>>> from pathlib import Path
>>> import datetime
>>> from np_aind_metadata import rigs

>>> rigs.copy_rig("NP3", datetime(2024, 4, 1), output_path=Path("rig.json"))
PosixPath('rig.json')

外部

更新rig json并在输出路径中存储。

>>> from pathlib import Path
>>> from np_aind_metadata.update import update_rig
>>> update_rig(
...     Path(".", "examples", "rig.json"),
...     open_ephys_settings_sources=[
...         Path(
...             ".",
...             "examples",
...             "example-session-directory",
...             "settings.xml"
...         ),
...     ],
...     output_path=Path("rig.json"),
... )
PosixPath('rig.json')

便利函数

直接支持常见用例。

np-codeocean

解析动态路由会话目录的session.json，添加相应的rig.json，并更新session.json以反映与其关联的rig.json。如果不在本地，则需要提供rig_storage_dir。

>>> from pathlib import Path
>>> from np_aind_metadata.integrations import dynamic_routing_task
>>> session_dir = Path("examples") / "example-session-directory"
>>> dynamic_routing_task.add_rig_to_session_dir(session_dir, datetime.datetime(2024, 4, 1))

模型存储

模型存储在本地磁盘上。要初始化模型存储。

初始化所有支持的rig的存储。

np-aind-metadata init-rig-storage "/directory/to/store/rigs"

初始化特定rig的存储。

np-aind-metadata init-rig-storage "/directory/to/store/rigs" "NP3" --date 2022/02/07

更新存储的rig。

np-aind-metadata update-rig "/directory/to/store/rigs" "NP3" --date 2022/02/07

本地开发

测试

测试针对从源代码控制复制的克隆项目。

单元测试

pdm run pytest

存储测试

pdm run pytest-storage

本地测试

需要用户可能在本地，并且已安装np组依赖项。

安装np组依赖项

pdm install -G np

运行测试

pdm run pytest-onprem

所有测试

需要来自本地的依赖项。

pdm run pytest-full

开发

请参阅https://github.com/AllenInstitute/np-aind-metadata/CONTRIBUTING.md和原始模板：https://github.com/AllenInstitute/copier-pdm-npc/blob/main/README.md