跳转到主要内容

支持Nancy Grace Roman空间望远镜校准的数据模型

项目描述

CI Weekly Cron codecov Documentation Status

Roman数据模型支持

安装

将最新版本的 roman-datamodels 安装到新的 virtualenv 或 conda 环境中,最简单的方法是

pip install roman-datamodels

详细安装

您可以通过 piproman-datamodels 包安装到 virtualenv 或 conda 环境中。我们建议对于每次安装,您首先创建一个全新的环境,只安装 Python,然后在该裸环境中安装 roman_datamodels 包及其依赖项。如果您使用 conda 环境,请首先确保您已经安装了最新的 Anaconda 或 Miniconda。如果需要,您可以创建多个环境,以便在不同版本的 roman-datamodels 包之间切换(例如,已发布的版本与当前开发版本)。

在所有情况下,安装通常是一个三步过程

  • 创建一个 conda 环境
  • 激活该环境
  • 将该环境的 roman-datamodels 包的所需版本安装到该环境中

以下将详细介绍如何进行不同类型安装的细节,包括标记版本、用于操作的 DMS 构建,以及开发版本。请记住,所有 conda 操作都必须在 bash shell 中完成。

安装最新版本

您可以通过 pip 安装最新发布的版本。从 bash shell 中

conda create -n <env_name> python
conda activate <env_name>
pip install roman-datamodels

注意
或者,您也可以使用 virtualenv 创建环境;然而,如果您遇到问题,STScI 不支持此安装方法。

您还可以安装特定版本(从 roman-datamodels 0.1.0 开始)

conda create -n <env_name> python
conda activate <env_name>
pip install roman-datamodels==0.5.0

从 Github 安装开发版本

您可以从 Github 的主分支安装最新的开发版本(测试可能不充分)

conda create -n <env_name> python
conda activate <env_name>
pip install git+https://github.com/spacetelescope/roman_datamodels

为开发者安装

如果您想能够使用 roman-datamodels 包对源代码进行工作和测试,您可以通过上述相同的过程首先创建一个 conda 环境,然后在那个环境中安装您自己的代码副本。再次提醒,这应该在单独的 conda 环境中进行,而不是与您已经安装的 roman-datamodels 包发布的版本相关的任何现有环境中。

像往常一样,前两步是创建和激活环境

conda create -n <env_name> python
conda activate <env_name>

要将您的代码副本安装到该环境中,您首先需要 fork 并克隆 roman_datamodels 仓库

cd <where you want to put the repo>
git clone https://github.com/spacetelescope/roman_datamodels
cd roman_datamodels

注意
通过 setup.py(例如 python setup.py installpython setup.py develop 等)进行安装已弃用且不工作。

从您的本地检出副本中安装为“可编辑”的安装

pip install -e .

如果您想运行单元测试或回归测试,以及/或者构建文档,请确保安装了这些依赖项

pip install -e ".[test]"
pip install -e ".[docs]"
pip install -e ".[test,docs]"

您的开发环境中需要其他有用的包吗?

pip install ipython pytest-xdist

项目详情


下载文件

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

源分发

roman_datamodels-0.21.0.tar.gz (155.9 kB 查看哈希值)

上传时间 源代码

构建发行版

roman_datamodels-0.21.0-py3-none-any.whl (54.1 kB 查看哈希值)

上传时间 Python 3

支持者