Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

data-notebook

cedarkit 工具套件数据分析示例 Jupyter 笔记本。

环境准备

本项目使用 uv 管理依赖。安装 uv 后,同步环境:

uv sync

reki 等未发布到 PyPI 的依赖通过本地可编辑安装提供,路径配置见 pyproject.toml 中的 [tool.uv.sources]

数据准备

示例笔记本使用本地数据目录 data/ 中的数据文件(按系统分目录保存,每个系统目录含 metadata.yaml 数据信息说明),通过 data_notebook.data.get_data_file 获取文件路径。

首次构建前需手动从 CMADAAS 挂载目录下载数据:

uv run data-notebook data download cma-gfs
uv run data-notebook data download cma-meso-1km

查看已下载的数据:

uv run data-notebook data list

数据根目录默认为项目根下的 data/(见 pyproject.toml[tool.data-notebook.data]),也可用环境变量 DATA_NOTEBOOK_DATA_ROOT 覆盖。data/ 目录中除占位文件外均被 git 忽略。

编译

因为使用到 CEMC 业务系统数据产品,需要在 CMA-HPC2023-SC1 中编译。

构建文档(会自动执行 Jupyter 笔记本):

uv run data-notebook build

强制重新构建所有页面:

uv run data-notebook build --all

清理构建目录:

uv run data-notebook clean

生成的网站放在 docs/_build/html 目录中。

浏览

启动本地 HTTP 预览服务器(自动选择端口):

uv run data-notebook serve

也可以使用旧式入口:

python tool/run_server.py

使用浏览器打开命令行输出的 URL 网址即可查看生成的文档网站。

脚本入口

scripts/ 目录下保留了兼容旧工作流的包装脚本:

  • scripts/build_doc.sh
  • scripts/run_doc_server.sh
  • scripts/update_env.sh

CLI 完整帮助

uv run data-notebook --help

License

Copyright © 2024-2026, developers at CMA Earth System Modeling And Prediction Centre.

data-notebook is licensed under Apache License, Version 2.0.

Contributors

Languages