Cylc 项目教程

1. 项目目录结构及介绍

Cylc 项目的目录结构如下：

cylc-flow/
├── doc/
│   ├── CONTRIBUTING.md
│   ├── INSTALL.md
│   ├── README.md
│   └── ...
├── etc/
│   ├── ...
├── test/
│   ├── ...
├── cylc/
│   ├── flow/
│   │   ├── __init__.py
│   │   ├── scheduler.py
│   │   └── ...
│   └── ...
├── CHANGES.md
├── COPYING
├── MANIFEST.in
├── pyproject.toml
├── setup.cfg
├── setup.py
└── tox.ini

目录介绍

• doc/: 包含项目的文档文件，如贡献指南、安装指南和README文件。
• etc/: 包含项目的配置文件和示例文件。
• test/: 包含项目的测试代码。
• cylc/flow/: 包含项目的主要代码，如调度器和其他核心功能。
• CHANGES.md: 记录项目的变更日志。
• COPYING: 包含项目的许可证信息。
• MANIFEST.in: 用于指定在打包时包含的文件。
• pyproject.toml: 用于定义项目的构建系统和其他元数据。
• setup.cfg: 包含项目的配置信息。
• setup.py: 用于安装项目的脚本。
• tox.ini: 用于定义项目的测试环境。

2. 项目启动文件介绍

Cylc 项目的启动文件主要位于 cylc/flow/ 目录下。以下是一些关键的启动文件：

• scheduler.py: 这是 Cylc 调度器的核心文件，负责管理和调度工作流中的任务。
• init.py: 这是 Python 包的初始化文件，通常包含包的初始化代码。

启动步骤

1. 安装 Cylc: 使用 conda 或 pip 安装 Cylc。

   conda install cylc-flow
   

2. 启动工作流: 使用 cylc play 命令启动工作流。

   cylc play <workflow-id>
   

3. 项目的配置文件介绍

Cylc 项目的配置文件主要位于 etc/ 目录下，以下是一些关键的配置文件：

• flow.cylc: 这是定义工作流的配置文件，包含任务和依赖关系。
• setup.cfg: 包含项目的配置信息，如安装路径、依赖项等。
• tox.ini: 用于定义项目的测试环境。

配置文件示例

flow.cylc

[scheduler]
allow implicit tasks = True

[scheduling]
[[graph]]
R1 = """
buy_ingredients => make_dough
pre_heat_oven & make_dough => bake_bread
bake_bread => sell_bread & clean_oven
"""

setup.cfg

[metadata]
name = cylc-flow
version = 8.3.0
description = Cylc: a workflow engine for cycling systems.
author = NIWA & British Crown (Met Office) & Contributors
license = GPL-3.0

tox.ini

[tox]
envlist = py37,py38

[testenv]
deps =
    pytest
commands =
    pytest

通过以上配置文件，可以定义和启动 Cylc 工作流，并进行相应的测试和部署。