DKIST仪器上的DLNIRSP科学处理代码
项目描述
概述
dkist-processing-dlnirsp库包含了DLNIRSP管道的实现,作为一个dkist-processing-core框架和dkist-processing-common任务的集合。
推荐的项目结构是将任务和工作流程分开到不同的包中。将工作流程放在自己的包中有助于使用build_utils来测试单元测试中的工作流程完整性。
校准管道
构建
通过Bitbucket Pipelines构建工件。
可以通过修改包和工件位置来在其他存储库中使用此管道,以使用与目标存储库相关的名称。
例如:dkist-processing-test -> dkist-processing-vbi 和 dkist_processing_test -> dkist_processing_vbi
部署
使用turtlebot进行部署,并遵循dkist-processing-core中详细说明的过程。
环境变量
开发
git clone git@bitbucket.org:dkistdc/dkist-processing-dlnirsp.git
cd dkist-processing-dlnirsp
pre-commit install
pip install -e .[test]
pytest -v --cov dkist_processing_nirsp
变更日志
当您对此存储库进行任何更改时,必须附带一个变更日志文件。此存储库的变更日志使用towncrier包。为下一个版本的变更日志条目添加为单独的文件(每个更改一个)到changelog/目录。
编写变更日志条目
应将伴随更改的变更日志条目添加到 changelog/ 目录中。该目录中文件的名称遵循特定的模板
<PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst
字段具有以下含义
<PULL REQUEST NUMBER>:这是拉取请求的编号,以便人们可以从变更日志条目跳转到 BitBucket 上的差异。
<TYPE>:这是更改的类型,必须是以下描述的值之一。
<COUNTER>:这是一个可选字段,如果您对同一类型的更改进行了多次更改,则可以追加计数器到后续更改中,例如,对于同一 PR 中的两个错误修复更改,可以使用 100.bugfix.rst 和 100.bugfix.1.rst。
可能类型的列表在 pyproject.toml 的 towncrier 部分中定义,类型包括:
feature:此更改是一个新的代码功能。
bugfix:这是一个修复错误的更改。
doc:文档更改。
removal:公共 API 的弃用或删除。
misc:任何不适合其他地方的微小更改,例如对包基础设施的更改。
发布时渲染变更日志
在您准备标记发布之前,首先必须运行 towncrier 来渲染变更日志。以下为操作步骤:
使用要标记的版本号运行 towncrier build –version vx.y.z。
同意让 towncrier 删除片段。
添加并提交您的更改。
标记发布。
注意:如果您忘记将变更日志条目添加到标记的发布(无论是手动还是通过 towncrier 自动),则 Bitbucket 管道将失败。要使用相同的标记,您必须在本地和远程分支上删除它。
# First, actually update the CHANGELOG and commit the update
git commit
# Delete tags
git tag -d vWHATEVER.THE.VERSION
git push --delete origin vWHATEVER.THE.VERSION
# Re-tag with the same version
git tag vWHATEVER.THE.VERSION
git push --tags origin main
科学变更日志
每当发布涉及 L1 数据的科学质量更改时,应创建额外的变更日志片段。这些片段旨在尽可能详细,以便准确地捕获更改的范围,因此请随时使用所有复杂的 RST。科学片段放置在其他片段相同的 changelog/ 目录中,但始终称为
<PR NUMBER | +>.science[.<COUNTER>].rst
如果单个拉取请求封装了全部科学更改,则第一个字段应为该 PR 编号(与常规 CHANGELOG 相同)。然而,如果没有简单的 PR 到科学更改的映射,则使用字符“+”;这将创建一个没有关联 PR 的变更日志条目。例如
$ ls changelog/
99.bugfix.rst # This is a normal changelog fragment associated with a bugfix in PR 99
99.science.rst # Apparently that bugfix also changed the scientific results, so that PR also gets a science fragment
+.science.rst # This fragment is not associated with a PR
在构建 SCIENCE_CHANGELOG 时,请使用此存储库中的 science_towncrier.sh 脚本。此脚本接受与默认 towncrier 相同的所有参数。例如
./science_towncrier.sh build --version vx.y.z
这将更新 SCIENCE_CHANGELOG 并从变更日志目录中删除任何科学片段。
项目详细信息
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分发
dkist_processing_dlnirsp-0.14.1.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 0d88aa8310f8780a426312d803d99e93cb5bb6596daf09521ada2f7b5a792dc7 |
|
MD5 | 5afa2d1da37bb28dabc179c4bb75b426 |
|
BLAKE2b-256 | 6eccbbd256526106ef6e279dc754598c92fed3ab24def4f6633c4994cea98bc8 |