DKIST套件仪器的光谱线元数据。
项目描述
概述
dkist-spectral-lines包整合了DKIST仪器观测到的光谱线相关元数据的定义。
用法
光谱线都定义为类,具有捕获其相关元数据的属性。可以使用辅助函数之一检索光谱线
from dkist_spectral_lines import get_spectral_lines
from dkist_spectral_lines import get_closest_spectral_line
spectral_lines_in_a_range = get_spectral_lines(wavelength_min=1, wavelength_max=1000)
closest_line = get_closest_spectral_line(wavelength=100)
构建
dkist-spectral-lines使用bitbucket-pipelines构建
部署
dkist-spectral-lines已部署到PyPI
环境变量
无
开发
git clone git@bitbucket.org:dkistdc/dkist-spectral-lines.git
cd dkist-spectral-lines
pre-commit install
pip install -e .[test]
pytest -v --cov dkist_spectral_lines
变更日志
当你对这个存储库进行任何更改时,它必须伴随一个变更日志文件。此存储库的变更日志使用towncrier包。下一个版本变更日志中的条目作为单个文件(每个更改一个)添加到changelog/目录。
编写变更日志条目
伴随更改的变更日志条目应添加到changelog/目录。此目录中文件的名称遵循特定的模板
<PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst
字段具有以下含义
<PULL REQUEST NUMBER>:这是拉取请求的编号,以便人们可以从变更日志条目跳转到BitBucket上的diff。
<TYPE>:这是更改的类型,必须是以下描述的值之一。
<COUNTER>:这是一个可选字段,如果您对同一类型的变更进行多次修改,可以将计数器附加到后续变更中,例如,对于同一PR中的两个bug修复变更,可以分别使用100.bugfix.rst和100.bugfix.1.rst。
可能的类型列表定义在pyproject.toml文件的towncrier部分,类型包括:
feature:这个变更是一个新的代码特性。
bugfix:这是一个修复bug的变更。
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
项目详情
下载文件
下载您平台上的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。
源代码分发
构建分发
dkist_spectral_lines-3.0.0.tar.gz的散列值
算法 | 散列摘要 | |
---|---|---|
SHA256 | 747774ab559780d41986386328de2a1b6484e8ff9883a3afbba6290b3c219afd |
|
MD5 | 7c9fcac0d99ba755b1147a487e5e0b51 |
|
BLAKE2b-256 | 7e1a397d6cbcb9697f9b3fb6fd8d8e77d7374dcf8123835f9d85cad8ee3d0b3c |