气候影响实验室的影响预测
impax的Python项目详细描述
===
impax
==
。图像::https://img.shields.io/pypi/v/impax.svg
:目标:https://pypi.python.org/pypi/impax
…图片::https://img.shields.io/travis/climateampactlab/impax.svg
:目标:https://travis ci.org/climateampactlab/impax
…图片::https://readthedocs.org/projects/impax/badge/?version=latest
:目标:https://impax.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片::https://pyup.io/repos/github/climateampactlab/impax/shield.svg
:目标:https://pyup.io/repos/github/climateampactlab/impax/
:alt:updates
https://impax.readthedocs.io.
如果您还没有在github上创建匹配的存储库:
a.转到https://github.com/organizations/climateimpactlab/repositories/new
b.输入以下信息:
climateimpactlab
repository name
impax
描述
气候影响实验室的影响预测
隐私
公共
**不要使用自述文件、许可证或gitignore初始化回购!**
c.按绿色大按钮
2.在此目录中执行以下命令:
…代码块::bash
git init
git add.
git commit-m"initial commit"
git remote add origin git@github.com:climateimpactlab/impax.git
git push-u origin master
3.设置自动测试、覆盖、更新,以及文档:
a.设置测试
i.转到https://travis-ci.org/并登录/注册GitHub。
通过启用
,确保Travis可以访问GitHub上的存储库
帐户*和ClimateImpactLab拥有的存储库。访问您的帐户设置。
ii.单击"我的存储库"旁边的"+"图标
iii.打开ClimateImpactLab/Impax。如果在列表中看不到它,请单击"同步帐户",并确保正在查看ClimateImpactLab存储库。
iv.对包进行更改(例如,可以删除此部分)。您应该会看到测试在travis上自动开始运行。
v.开始在
``impax/tests``文件夹中为代码编写测试。已经有一些
示例可以帮助您入门。
>b.设置文档
相同的交易-确保readthedocs可以访问您的github
账户和气候账户。单击"导入项目",转到ClimateImpactLab并刷新。
iii.单击
ClimateImpactLab/Impax旁边的"+"图标。为您的
项目选择一个名称。该名称必须是全局唯一的(不只是在
ClimateImpactLab中),因此如果您选择了一个通用的
名称,则可能需要重命名文档。
iv.转到新文档站点的"设置"页,并导航到"高级设置"选项卡。
将"requirements\u rtd.txt"添加到"requirements file"字段。
v.下次将代码推送到master时,文档应自动生成
。您可以在
https://impax.rea查看它们dthedocs.io/en/latest/
(替换您选择的任何名称)。
i.转到https://pyup.io。你知道这个练习。
我知道。转到您的帐户,然后单击"+添加回购"。同步。
iii.添加climateimpactlab/impax
并打开"依赖项更新"和"安全性"。关闭"更新计划"。
d.设置测试覆盖率监控
e.放松呼吸。下一次您推送代码时,这些都应该为
您更新!那还不算太糟吧?
4.使用github开发:
a.通常,当您想要更改某个内容或发现错误时,最好提交一个问题,然后编写测试来预先测试关于所需行为的断言,然后编写通过这些测试所需的最少
代码。有关更多
工作流建议,请参阅相关文档。
要在本地计算机上运行所有测试:
…代码块:bash
make test
>5。部署
a.通过在python包索引上注册包来设置部署
(pypi):
ii.注册包:
…代码块::bash
…代码块::bash
python travis_pypi_setup.py
…代码块::bash
bumpversion patch(或minor或major)
git push
git push--tags
Travis将为您部署
代码块::bash
features
-------
*todo
credits
--
此软件包是使用cookiecutter和"audreyr/cookiecutter pypackage"项目模板创建的。
_ Cookiecutter:https://github.com/audreyr/Cookiecutter
。_` audreyr/cookiecutter-pypackage`:https://github.com/audreyr/cookiecutter-pypackage
==
==
=
<0.1.2(当前版本)
=>
-
*:py:func:`impax.csvv.get-u-gammas`已经被弃用。是的用法:py:func:`impax.read_csvv`代替(:issue:`37`)
*:py:meth:`~impax.csvv.gammas.`u prep_gammas`已被删除,并且:py:meth:`~impax.csvv.gammas.sample`现在
不接受参数,默认情况下返回示例。将随机数生成器的种子设定留给用户(:issue:`36`)
修复导致在:py:mod:`impax.mins`模块中找不到最小值的主要数学错误,并澄清文档(:issue:`58`)
>0.1.0(2017-10-12)
----
*pypi上的第一个版本。
impax
==
。图像::https://img.shields.io/pypi/v/impax.svg
:目标:https://pypi.python.org/pypi/impax
…图片::https://img.shields.io/travis/climateampactlab/impax.svg
:目标:https://travis ci.org/climateampactlab/impax
…图片::https://readthedocs.org/projects/impax/badge/?version=latest
:目标:https://impax.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片::https://pyup.io/repos/github/climateampactlab/impax/shield.svg
:目标:https://pyup.io/repos/github/climateampactlab/impax/
:alt:updates
https://impax.readthedocs.io.
如果您还没有在github上创建匹配的存储库:
a.转到https://github.com/organizations/climateimpactlab/repositories/new
b.输入以下信息:
repository name
impax
描述
气候影响实验室的影响预测
隐私
公共
**不要使用自述文件、许可证或gitignore初始化回购!**
c.按绿色大按钮
2.在此目录中执行以下命令:
…代码块::bash
git init
git add.
git commit-m"initial commit"
git remote add origin git@github.com:climateimpactlab/impax.git
git push-u origin master
3.设置自动测试、覆盖、更新,以及文档:
a.设置测试
i.转到https://travis-ci.org/并登录/注册GitHub。
通过启用
,确保Travis可以访问GitHub上的存储库
帐户*和ClimateImpactLab拥有的存储库。访问您的帐户设置。
ii.单击"我的存储库"旁边的"+"图标
iii.打开ClimateImpactLab/Impax。如果在列表中看不到它,请单击"同步帐户",并确保正在查看ClimateImpactLab存储库。
iv.对包进行更改(例如,可以删除此部分)。您应该会看到测试在travis上自动开始运行。
v.开始在
``impax/tests``文件夹中为代码编写测试。已经有一些
示例可以帮助您入门。
>b.设置文档
账户和气候账户。单击"导入项目",转到ClimateImpactLab并刷新。
iii.单击
ClimateImpactLab/Impax旁边的"+"图标。为您的
项目选择一个名称。该名称必须是全局唯一的(不只是在
ClimateImpactLab中),因此如果您选择了一个通用的
名称,则可能需要重命名文档。
iv.转到新文档站点的"设置"页,并导航到"高级设置"选项卡。
将"requirements\u rtd.txt"添加到"requirements file"字段。
v.下次将代码推送到master时,文档应自动生成
。您可以在
https://impax.rea查看它们dthedocs.io/en/latest/
(替换您选择的任何名称)。
i.转到https://pyup.io。你知道这个练习。
我知道。转到您的帐户,然后单击"+添加回购"。同步。
iii.添加climateimpactlab/impax
并打开"依赖项更新"和"安全性"。关闭"更新计划"。
d.设置测试覆盖率监控
e.放松呼吸。下一次您推送代码时,这些都应该为
您更新!那还不算太糟吧?
4.使用github开发:
a.通常,当您想要更改某个内容或发现错误时,最好提交一个问题,然后编写测试来预先测试关于所需行为的断言,然后编写通过这些测试所需的最少
代码。有关更多
工作流建议,请参阅相关文档。
要在本地计算机上运行所有测试:
…代码块:bash
make test
>5。部署
a.通过在python包索引上注册包来设置部署
(pypi):
…代码块::bash
…代码块::bash
python travis_pypi_setup.py
…代码块::bash
bumpversion patch(或minor或major)
git push
git push--tags
Travis将为您部署
代码块::bash
features
-------
*todo
credits
--
此软件包是使用cookiecutter和"audreyr/cookiecutter pypackage"项目模板创建的。
_ Cookiecutter:https://github.com/audreyr/Cookiecutter
。_` audreyr/cookiecutter-pypackage`:https://github.com/audreyr/cookiecutter-pypackage
==
==
=
<0.1.2(当前版本)
=>
-
*:py:func:`impax.csvv.get-u-gammas`已经被弃用。是的用法:py:func:`impax.read_csvv`代替(:issue:`37`)
*:py:meth:`~impax.csvv.gammas.`u prep_gammas`已被删除,并且:py:meth:`~impax.csvv.gammas.sample`现在
不接受参数,默认情况下返回示例。将随机数生成器的种子设定留给用户(:issue:`36`)
修复导致在:py:mod:`impax.mins`模块中找不到最小值的主要数学错误,并澄清文档(:issue:`58`)
>0.1.0(2017-10-12)
----
*pypi上的第一个版本。