跳转到主要内容

詹姆斯·韦伯空间望远镜快速查看项目

项目描述

JWST快速查看应用程序 (JWQL)

Current Release PyPI - License Python Build Status Documentation Status STScI DOI codecov

JWST快速查看应用程序 (JWQL) 是一个数据库驱动的Web应用程序和自动化框架,供JWST仪器团队使用,用于监控和趋势分析JWST仪器的健康状况、稳定性和性能。该系统由以下部分组成

  1. 一个网络文件系统,将所有未经校准和校准过的数据产品存储在中央位置的磁盘上,可供仪器团队成员(即MAST数据缓存)访问。
  2. 一个关系型数据库,存储观测元数据,允许通过关系查询进行数据发现(MAST数据库API)。
  3. 一个软件库,提供工具以支持自动化框架,用于构建自动化仪器监控程序。
  4. 一个网络应用,允许用户直观检查新的和存档的JWST数据以及仪器特定的监控和性能结果。

官方API文档可在ReadTheDocs找到。

jwql应用程序可在https://jwql.stsci.edu获取。请注意,该应用程序目前仅限特定JWST仪器团队成员使用。

用户安装

要安装jwql,只需使用pip

pip install jwql

以下部分描述了用户希望为jwql存储库做出贡献的更详细安装方法。

贡献者安装

在您的计算机上运行jwql需要以下四个步骤,具体如下:

  1. 克隆GitHub存储库
  2. 安装conda环境
  3. 安装Python包
  4. 设置配置文件

先决条件

强烈建议贡献者拥有Python 3.10+的anacondaminiconda的有效安装。下载和安装说明可在此处找到

为贡献到jwql包所需的要求将包含在我们的以下安装说明中jwql conda环境,该环境包含在下面的安装说明中。将提供进一步的包要求,通过存储库中的pyproject.toml文件提供的jwql

克隆jwql存储库

首先需要克隆当前版本的jwql。最简单的方法是转到您想要存储库副本的目录,并在该目录中克隆存储库。一旦进入目录,就可以执行以下操作

git clone https://github.com/spacetelescope/jwql.git
cd jwql

或者,如果您想使用SSH而不是https,请输入

git clone git@github.com:spacetelescope/jwql.git
cd jwql

然后继续按照说明操作。

环境安装

下载jwql存储库后,贡献者可以通过环境yaml文件安装jwql conda环境,该文件包含项目的所有依赖项。首先,如果需要,请安装conda。接下来,确保您的conda版本是最新的

conda update conda

接下来,激活baseroot环境(取决于您的conda版本)

source activate base/root

注意:如果您已将激活conda的步骤添加到默认终端/shell(例如,.bashrc.zshrc.profile文件)中,那么您不需要执行上述步骤。

最后,通过以下任一environment.yml文件创建jwql环境(目前jwql支持python 3.9的environment_python_3.9.yml和python 3.10的environment_python_3.10.yml》)

conda env create -f environment_python_3.10.yml

或者

conda env create -f environment_python_3.11.yml

配置文件

大部分jwql软件依赖于jwql目录中存在一个config.json文件。此文件包含可能对用户唯一或包含敏感信息的数据。请参阅配置文件wiki页面以获取提供此文件的说明。

引用

如果您使用JWQL在出版物(无论是直接使用还是作为其他包的依赖项)中展示工作/研究,我们建议并鼓励以下致谢

  This research made use of the open source Python package 'jwql' (Bourque et al, 2020).

其中(Bourque 等人,2020)是使用上方的 DOI 徽章可获取的 Zenodo 记录的引用。通过使用 Zenodo 页面右下角的 导出 框,您可以以最方便的格式导出引用。

软件贡献

在您开始为 jwql 开发做出贡献之前,需要先审查两个当前页面。第一个是我们的 风格指南,第二个是我们的 推荐的 Git 工作流程页面,其中包含对工作流程的深入解释。

鼓励贡献者查看 贡献者指南清单,以确保拉取请求包含所有必要的更改。

以下是一个为项目做出贡献的最佳工作流程的简单示例

  1. spacetelescope jwql 仓库创建一个分支。
  2. 克隆您的分支到本地。
  3. 确保您的个人分支正确指向 上游
  4. 在个人分支上创建一个分支。
  5. 进行软件更改。
  6. 将那个分支推送到您的个人 GitHub 仓库(即 origin)。
  7. spacetelescope jwql 仓库上,创建一个拉取请求,将分支合并到 spacetelescope:develop
  8. 为拉取请求分配团队成员作为审阅者。
  9. 与审阅者迭代任何必要的更改,直到审阅者接受并合并您的分支。
  10. 删除您本地的分支副本。

问题报告/功能请求

希望报告问题或请求新功能的用户可以通过以下渠道进行

  1. 在 GitHub 上提交新的问题(首选方法):https://github.com/spacetelescope/jwql/issues
  2. 在 Jira 上提交新票据:https://jira.stsci.edu/projects/JWQL/

行为准则

所有用户和 jwql 仓库的贡献者应遵守 行为准则。任何与行为准则相关的问题或违规行为应通知 jwql 团队成员或发送至 jwql@stsci.edu

问题

有关 jwql 项目或其软件的任何问题都可以发送至 jwql@stsci.edu

当前开发团队

过往开发团队成员

致谢

  • faith abney(DMD)
  • Joshua Alexander(DMD) @obviousrebel
  • Anastasia Alexov(DMD)
  • 萨拉·安德森(DMD)
  • 特雷西·贝克(INS)
  • 弗朗切斯卡·博菲(INS) @frboffi
  • 克拉拉·布拉瑟(DMD) @ceb8
  • 马修·伯格(DMD)
  • 史蒂文·克劳福德(DMD) @stscicrawford
  • 詹姆斯·戴维斯(DMD) @jdavies-st
  • 罗莎·迪亚兹(INS) @rizeladiaz
  • 范·迪克森(INS)
  • 拉里·多林(ITSD)
  • 汤姆·唐纳森(DMD) @tomdonaldson
  • 金·杜普里(DMD)
  • 乔纳森·艾森哈默(DMD) @stscieisenhamer
  • 本·法尔克(DMD) @falkben
  • 安·费尔德(OPO)
  • 迈克·福克斯(DSMO) @mfox22
  • 斯科特·弗里德曼(INS)
  • 亚历克斯·富尔顿(INS) @awfullerton
  • 玛卡雷纳·加西亚·马林(INS)
  • 丽莎·加德纳(DMD)
  • 维拉·吉布斯(ITSD)
  • 凯瑟琳·戈斯梅耶(INS) @cgosmeyer
  • 菲尔·格兰特(ITSD)
  • 迪恩·海因斯(INS)
  • 谢里·霍夫尔特茨(INS) @stholfeltz
  • 乔·亨克尔(DMD) @jhunkeler
  • 凯瑟琳·卡莱达(DMD) @ckaleida
  • 多比·肯尼(DMD)
  • 詹妮·科特勒(DMD) @jenneh
  • 丹尼尔·库赫巴赫(戈达德) @DanielKuebi
  • 马克·基普里昂纽(DMD) @mkyp
  • 斯蒂芬妮·拉·马斯萨(INS)
  • 马修·拉洛(INS)
  • 卡伦·莱瓦伊(DMD)
  • 克里斯塔尔·曼福德克(SCOPE) @cmannfolk
  • 格雷格·马西(ITSD)
  • 雅各布·马图斯基(DMD) @jmatuskey
  • 玛格丽特·梅克纳(INS)
  • 克里斯蒂安·梅什(DMD) @cam72cam
  • 普雷姆·米什拉(ITSD)
  • 唐·穆勒(ITSD)
  • 玛丽亚·安东尼亚·尼托-桑蒂斯蒂班(SEITO)
  • 布赖恩·奥沙利文(INS)
  • 乔·波利齐(JWSTMO)
  • 李·奎克(DMD)
  • 阿努普inder·雷(ITSD)
  • 马特·雷丁纳(DMD) @rendinam
  • 马西莫·罗伯托(INS) @mrobberto
  • 玛丽·罗梅尔法格尔(DMD)
  • 伊莱娜·萨比(INS)
  • 伯尼·肖(DMD)
  • 马修·西尼亚基维茨(ITSD)
  • 阿弗恩·史密斯(DSMO) @arfon
  • 琳达·史密斯(INS)
  • 帕特里克·泰勒(ITSD)
  • 戴夫·昂格尔(ITSD)
  • 杰夫·瓦伦蒂(JWSTMO) @JeffValenti
  • 杰夫·瓦格纳(ITSD)
  • 托马斯·沃克(ITSD)
  • 杰夫·华莱士(DMD)
  • 拉拉·威尔金森(OPO)
  • 亚历克斯·叶尔莫拉耶夫(ITSD) @alexyermolaev
  • 乔·扎恩(ITSD)

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

jwql-1.2.11.tar.gz (29.9 MB 查看哈希值)

上传于 源代码

构建分发

jwql-1.2.11-py3-none-any.whl (29.5 MB 查看哈希)

上传于 Python 3

由以下支持