跳转到主要内容

输入4MIPs数据的验证(检查文件格式、元数据等)。

项目描述

Input4MIPs-validation

输入4MIPs数据的验证(检查文件格式、元数据等)。

关键信息: Docs Main branch: supported Python versions Licence

PyPI: PyPI PyPI install

Conda: Conda Conda platforms Conda install

测试: CI Coverage

其他信息: Last Commit Contributors

状态

  • 开发:项目正在积极开发中

作为用户,请注意,input4MIPs验证正在经历快速开发。这意味着今天通过验证的文件可能在将来无法通过。虽然这起初可能让人沮丧,但长期来看,这将帮助我们创建尽可能干净、清晰的数据集。我们希望您也能理解这一点(我们希望在未来某个时刻也能认可为此付出的努力,敬请关注)。因此,请享受这个工具,请充分利用它,请提出问题,但请随时准备在三个月到六个月后提交下一轮文件时更新您的文件编写脚本。

如果您想为ESGF上的发布准备input4MIPs文件,请参阅“如何为ESGF上的发布准备input4MIPs文件?”

完整文档可在以下位置找到:input4mips-validation.readthedocs.io。我们建议阅读那里的文档,因为GitHub查看器上的内部文档链接无法正确显示。

安装

作为应用程序

如果您想将input4MIPs-validation用作应用程序,例如您只想使用其命令行界面,那么我们建议使用该软件包的“锁定”版本。此版本还固定了所有依赖项的版本,从而减少了由于依赖项更新而导致的安装问题的可能性。

可以使用以下命令安装input4mips-validation的锁定版本:

=== "mamba" sh mamba install -c conda-forge input4mips-validation-locked

[mamba](https://mamba.readthedocs.io/en/latest/)
is our recommend way to install the package
because it has better handling of the compiled dependencies
(like cfunits).

=== "conda" sh conda install -c conda-forge input4mips-validation-locked

[conda](https://docs.conda.org.cn/projects/conda/en/stable/)
is a good way to install the package
because it has better handling of the compiled dependencies
(like cfunits).

=== "pip" sh pip install input4mips-validation[locked]

[pip](https://pip.pythonlang.cn/en/stable/)
is a standard way to install Python packages.
We make no guarantees that this will actually work
because pip's handling of the compiled dependencies
is not guaranteed.

作为库

如果您想将input4MIPs-validation用作库,例如您想将其用作您构建的另一个包/应用程序的依赖项,那么我们建议使用以下命令安装该软件包。此方法提供了所有依赖项中最宽松的固定版本。这为您,即包/应用程序的开发者,提供了尽可能多的自由来设置不同包的版本。然而,这种自由的代价是您可能安装了input4mips-validation依赖项的不兼容版本(我们无法测试所有依赖项的组合,特别是尚未发布的那些!)。因此,您可能会遇到安装问题。如果您认为这些问题是由于input4mips-validation中的问题引起的,请提出问题

可以使用以下命令安装input4mips-validation的(非锁定)版本:

=== "mamba" sh mamba install -c conda-forge input4mips-validation

[mamba](https://mamba.readthedocs.io/en/latest/)
is our recommend way to install the package
because it has better handling of the compiled dependencies
(like cfunits).

=== "conda" sh conda install -c conda-forge input4mips-validation

[conda](https://docs.conda.org.cn/projects/conda/en/stable/)
is a good way to install the package
because it has better handling of the compiled dependencies
(like cfunits).

=== "pip" sh pip install input4mips-validation

[pip](https://pip.pythonlang.cn/en/stable/)
is a standard way to install Python packages.
We make no guarantees that this will actually work
because pip's handling of the compiled dependencies
is not guaranteed.

可以使用以下方法安装额外的依赖项

=== "mamba" 如果你使用mamba进行安装,我们建议手动安装额外组件,因为目前还没有稳定的解决方案(见 conda问题#7502

=== "conda" 如果你使用conda进行安装,我们建议手动安装额外组件,因为目前还没有稳定的解决方案(见 conda问题#7502

=== "pip" sh # 要添加绘图依赖项 pip install input4mips-validation[plots] # 要添加笔记本依赖项 pip install input4mips-validation[notebooks]

针对开发者

为了开发,我们依赖于pixi来管理所有依赖项。要开始,请确保pixi已安装(这里提供说明)。

我们依赖pdm来管理我们的PyPI构建。因此,你也需要确保你的系统上已安装pdm(这里提供说明,尽管我们发现使用pipx安装效果非常好)。

对于我们的所有工作,我们使用我们的Makefile。如果你愿意,可以手动阅读说明并运行命令,但我们通常不建议这样做,因为它容易出错。为了创建你的环境,请运行make virtual-environment

如果有任何问题,Makefile中的消息应能引导你解决问题。如果没有,请在本问题跟踪器中提出问题。

有关我们其余的开发者文档,请参阅[开发][开发参考]。

项目详情


下载文件

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

源代码发行版

input4mips_validation-0.13.0.tar.gz (88.7 kB 查看哈希值)

上传时间 源代码

构建发行版

input4mips_validation-0.13.0-py3-none-any.whl (94.6 kB 查看哈希值)

上传时间 Python 3

支持