TOSICA项目使用教程

1. 项目目录结构及介绍

TOSICA项目的目录结构如下：

TOSICA/
├── reproducibility/
│   ├── test/
│   └── ...
├── setup.py
├── setup.cfg
├── MANIFEST.in
├── README.md
├── LICENSE
├── TOSICA.yaml
├── VERSION.txt
└── ...

介绍：

• reproducibility/：此目录包含用于确保项目可重现性的脚本和数据。
• setup.py：Python打包配置文件，用于安装包。
• setup.cfg：包含包的元数据和构建选项的配置文件。
• MANIFEST.in：指定在打包时应该包括哪些文件。
• README.md：项目说明文件，包含项目信息、安装和使用指南。
• LICENSE：项目许可证文件，本项目采用MIT许可证。
• TOSICA.yaml：项目配置文件，包含项目相关的配置信息。
• VERSION.txt：项目版本文件。

2. 项目的启动文件介绍

项目的启动主要通过setup.py文件进行。以下为setup.py的基本内容：

from setuptools import setup, find_packages

setup(
    name='TOSICA',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        'scanpy',
        'torch==1.7.1',
        # 其他依赖
    ],
    # 其他元数据
)

此文件定义了项目的名称、版本、包含的包、依赖项等。使用pip install .命令可以从项目根目录安装TOSICA。

3. 项目的配置文件介绍

项目的配置主要通过TOSICA.yaml文件进行。以下为TOSICA.yaml的基本内容示例：

# TOSICA配置文件
project_name: my_project
label_name: label_key
gmt_path: path_to_gmt_files
# 其他配置项

此文件包含项目名称、标签名称、GMT文件路径等配置信息。在训练或预测时，这些配置项会被用来确定模型保存的路径、使用的GMT文件等。

在使用项目时，需要根据实际情况修改TOSICA.yaml中的配置项以确保项目能够正确运行。