Skip to content

ohmeta/skillpi

Repository files navigation

SkillPI

Skill Catalogue for Microbiome Informatics Study

微生物组信息学技能目录 - 帮助研究人员快速找到合适的工具并学习使用方法。


🚀 快速开始

安装依赖

# Node.js 依赖 (文档)
npm install

# Python 依赖 (工具)
pip install -e ".[dev,pipeline]"

本地开发

# 启动文档网站
npm run dev
# 访问 http://localhost:5173

# 生成技能文档
python scripts/generate_from_example.py

部署

# 构建静态站点
npm run build

# 部署到 GitHub Pages
git push origin main
# GitHub Actions 会自动部署

📚 核心内容

🛠️ 分析工具 (7 个核心工具)

工具 用途 难度
MetaPhlAn 4 物种级分类分析
HUMAnN 3 功能谱分析 ⭐⭐
QIIME 2 扩增子分析平台 ⭐⭐
DADA2 ASV 去噪 ⭐⭐
mothur 16S 分析 ⭐⭐
fastp 质量控制
MEGAHIT 宏基因组组装 ⭐⭐⭐

🔄 工作流

📖 核心概念


📊 项目统计

  • 16+ 工具和工作流
  • 4 核心概念
  • 100% 数据来自官方文档
  • 26 Git Commits

🎯 学习路径

初学者:16S 分析

16S 概念 → fastp 质控 → QIIME 2/DADA2 → 多样性分析

进阶:宏基因组

宏基因组概念 → MEGAHIT 组装 → MetaPhlAn → HUMAnN

🛠️ 技术栈

文档网站

  • VitePress - 现代文档框架
  • Vue 3 - 前端框架

Python 工具

  • Pydantic - 数据验证
  • BeautifulSoup - 网页爬虫
  • Snakemake - 工作流管理

数据源

  • GitHub API - 工具信息
  • PyPI API - Python 包
  • 官方文档 - 详细说明

📁 项目结构

skillpi/
├── docs/                    # 文档网站
│   ├── .vitepress/         # VitePress 配置
│   ├── skills/             # 技能文档
│   ├── guide/              # 使用指南
│   └── index.md            # 主页
├── src/skillpi/            # Python 包
│   ├── models.py           # 数据模型
│   ├── scrapers/           # 爬虫模块
│   └── generators/         # 文档生成器
├── scripts/                # 辅助脚本
├── data/                   # 数据文件
├── tests/                  # 测试
├── package.json            # Node.js 配置
└── pyproject.toml          # Python 配置

📖 文档


🧪 测试

# 运行测试
pytest

# 代码格式化
black src/ tests/
ruff check src/ tests/

# 类型检查
mypy src/

🤝 贡献

  1. Fork 仓库
  2. 创建分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 创建 Pull Request

📄 许可证

MIT License


🙏 致谢

感谢以下开源项目:


📬 联系方式


最后更新: 2026-03-18

About

Working in progress (Don't use it)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors