README.md

# csst-dag

更新：
- [2025-09-09] csst-dag将被封装为Docker镜像，原有的基于`python -m csst_dag.cli`的命令行调用方式将被放弃

# Usages

运行之前，需要确定一个本地的 `.csst` 文件夹。

在.bashrc中加入以下代码

```shell
# 确定本地 .csst 文件夹路径
export DOT_CSST=.csst
# 用自定义命令
alias csst='docker run --rm -it -v ${DOT_CSST}:/pipeline/app/.csst csu-harbor.csst.nao:10443/csst/csst-dag'
```

使 `DOT_CSST` 和 `csst` 命令生效：

```shell
source ~/.bashrc   # or source ~/.zshrc
```

创建 `.csst` 文件夹：

```shell
# 创建`.csst`文件夹
mkdir -p ${DOT_CSST}
```

测试csst命令是否可以执行：

```shell    
# 执行命令
csst --help
```

## 使用预定义环境变量文件

```shell
# 1. 查看所有预定义环境变量
csst env list

# 2. 查看环境变量
csst env show --name csu

# 3. 保存环境变量到文件
csst env init --name csu
```

## ``csst plan``
```shell
# 1. 查看编排数据
csst plan \
    --dataset=csst-msc-c9-25sqdeg-v3 \
    --instrument=MSC \
    --obs-type=WIDE \
    --obs-group=W1 \
    --obs-id=10100232366
```


## ``csst dag``
```shell
1. 发起任务
csst dag run **kwargs # 发起任务

2. 查看任务状态（批量）
csst dag status **kwargs # 查看任务状态

3. 查看任务日志（批量和单个）
csst dag log **kwargs # 查看任务日志

4. 取消任务（按条件批量取消，按任务ID取消，或者取消所有）
csst dag cancel **kwargs # 取消任务

5. 0级数据查看
csst raw **kwargs # 查看原始数据

6. 数据产品查看 (可能要区分DFS1/2)
csst product **kwargs # 查看产品数据

# TODO: 增加一个stats命令/选项，按照某些列来统计数据产品
```