Wellies

一组构建一致pyflow套件的工具。

使用pip

首先，您需要确保您的系统已安装ecFlow。最简单的方法是创建一个conda环境。我们建议使用mamba来加快环境创建过程

$ mamba create -c conda-forge -n wellies-env python=3.10 ecflow
$ conda activate wellies-env

然后，可以直接使用pip安装wellies

$ python -m pip pyflow-wellies

从源码

首先，构建一个包含所有依赖项的conda环境

mamba env create -f ./environment.yml -n wellies-env
conda activate wellies-env

然后，在您的环境中安装wellies

pip install .

快速入门

创建空套件

要创建一个具有默认wellies结构的空套件，只需运行

wellies-quickstart /path/to/project -p mysuite

一旦创建套件，就可以构建它

cd /path/to/project
./mysuite.py configs/*.yaml

这相当于

./mysuite.py configs/config.yaml config/tools.yaml configs/data.yaml config/execution_contexts.yaml

您也可以根据需要挑选配置文件

cd /path/to/project
./mysuite.py configs/config.yaml config/tools.yaml

贡献

构建包

要构建源分布，需要build。有了它，源分布可以从任何环境中构建

git clone https://github.com/ecmwf/pyflow-wellies.git
cd pyflow-wellies
python -m build

测试

要运行测试，首先安装测试依赖项

git clone https://github.com/ecmwf/pyflow-wellies.git
cd pyflow-wellies
pip install .[test]

然后运行所有测试

python -m pytest

运行单个测试

python -m pytest tests/test_data.py::test_rsync_data

文档

要构建自己的本地文档，您需要mkdocs和一些额外的插件。由于文档中有许多自动生成的部分，您需要安装所有依赖项的环境来构建文档。要安装仅文档的依赖项

git clone https://github.com/ecmwf/pyflow-wellies.git
cd pyflow-wellies
pip install .[docs]

然后构建它

mkdocs build

构建并在本地服务器上提供

mkdocs serve