该软件包用于开发预测算法。
deepdata_alpha的Python项目详细描述
################################################################################
deepdata_alpha
################################################################################
The package is for developing algorithm in prediction.
Project Setup
*************
Here we provide some details about the project set起来。大多数选择在"guide<;https://guide.esciencecenter.nl>;"中解释。相关章节的链接如下所示。
当软件包的开发开始时,请随意删除此文本。
有关软件开发的快速参考,请参阅"软件指南检查表"<;https://guide.esciencecenter.nl/best\u practices/checklist.html>;`.
版本控制
------
创建python包后,将其置于
`version control<;https://guide.esciencecenter.nl/best\u practices/version\u control.html>;`!
我们建议使用"git<;http://git scm.com/>;``和"github<;https://github.com/>;```.
代码块::console
git init
git add-a
git commit
ython版本:
*3.4
*3.5
*3.6
>根据项目需求添加或删除python版本。`指南<;https://guide.esciencecenter.nl/best_practices/language_guides/python.html>;```包含有关python版本和编写python 2和3兼容代码的更多信息。
包管理和依赖项包裹管理。由于项目需求不同,此存储库不会强制您使用其中一个或另一个。如需有关使用方法的建议,请查看"指南的相关部分"https://guide.esciencecenter.nl/best-practices/language-guides/python.html"依赖项和包管理"` ` `.
*应将依赖项添加到"install-requires"列表中的"setup.py"中。
packaging/one command install-----
您可以使用pipy或conda分发代码。同样,项目模板不强制使用任何一个。`指南<;https://guide.esciencecenter.nl/best廑u practices/language廑guides/python.html廑building and packaging code>;``可以帮助您决定要使用哪种工具进行打包。
测试和代码覆盖率
----
*测试应放在"测试"文件夹中。
*tests`文件夹包含:
-e例如,您应该用自己有意义的测试(文件:`` test_deepdata_alpha``)
-检查代码是否符合python样式指南(pep 8)的测试(文件:`` test_lint.py`)
*使用的测试框架是`pytest<;https://pytest.org>;`` py
-`pytest introduction<;http://python testing.net/framework/py test/pytest introduction/>;``u
*测试可以使用``python setup.py test``
-这在``setup.py``和``setup.cfg`
*使用`travis ci<;https://travis ci.com/>;``自动运行测试并使用多个python版本进行测试
-配置可以在`.t中找到ravis.yml``
-` travis ci入门<;https://docs.travis ci.com/user/getting started/>;`
*todo:添加一些关于代码质量/覆盖率工具的内容?
*《指南》中的相关章节<;https://guide.esciencecenter.nl/best戋u practices/language戋guides/python.html戋testing>;`戋
文档
----
*文档应放在"docs"文件夹中。内容是用"sphinx"生成的-quickstart``(sphinx版本1.6.5)。
*我们建议使用重组文本(rest)和谷歌风格的docstring编写文档。
-`重组文本(rest)和sphinx备忘表<;http://openalea.gforge.inria.fr/doc/openalea/doc//build/html/source/sphinx/rest_syntax.html>;`
-`谷歌风格的文档字符串示例<;http://sphinxcontrib napoleon.read the docs.io/en/latest/example撸google.html>;``.
*文档设置为读取文档sphinx主题。
-查看"配置选项"<;https://sphinx-rtd-theme.readthedocs.io/en/latest/>;` `.
*要生成HTML文档,请运行``python setup.py build_sphinx``
-这在``setup.cfg`
-或者,在``docs``文件夹中运行``make html`.
*docs/u templates`目录包含一个(空)`.gitignore``file,以便能够将其添加到存储库中。可以安全地删除此文件(或者您可以将其保留在那里)。
*若要将文档放在"读取文档"上,请登录到"读取文档"帐户,然后导入存储库(在"我的项目"下)。
-在此区域中包括指向文档的链接dme'.
*`指南中的相关章节<;https://guide.esciencecenter.nl/best_practices/language_guides/python.html writingdocumentation>;`
编码风格惯例和代码质量
--------
*使用"潜在客户"检查您的代码风格或者`
*您可能需要运行``pip install.[dev]``首先,要安装所需的依赖项
*您可以使用``yapf``修复代码样式的可读性,并使用``isort``格式化和分组导入
*`指南中的相关部分<;https://guide.esciencecenter.nl/best\u practices/语言指南/python.html编码风格惯例>;`
package version number
----
*我们建议使用"语义版本控制"<;https://guide.esciencecenter.nl/best_u practices/releases.html语义版本控制>;`
*为方便起见,软件包版本SION存储在一个地方:``deepdata\u alpha/\u version\uuuu.py``。要更新版本号,只需更改此文件。
*在"发布"之前,请不要忘记更新版本号,lt;https://guide.esciencecenter.nl/best戋u practices/releases.html>;`!
changelog.rst
----
*文档对您的软件包的更改
*`指南中的相关部分<;https://guide.esciencecenter.nl/software/releases.html changelogmd>;`
引文.cff
----
dd a``citation.cff``文件
*只有在有要引用的东西(例如,带有doi的软件发行版)时才有意义。
*遵循指南中的"使软件可引用"部分:https://guide.esciencecenter.nl/citable\u software/making\u software\citable.html>;``。
cod行为规范。rst
----
*关于如何表现专业行为的信息
*`指南中的相关章节<;https://guide.esciencecenter.nl/software/documentation.html行为规范>;`
----
*关于H的信息如何为本软件包贡献
*`指南中的相关部分<;https://guide.esciencecenter.nl/software/documentation.html贡献指南>;`
manifest.in
——
*列出应包含在源发行版中的非python文件
*`指南中的相关章节<;https://guide.esciencecenter.nl/best_practices/language_guides/python.html构建和打包代码>;`
注意
----
*此项目的属性列表和apache许可依赖关系
*`指南中的相关章节<;https:。//guide.esciencecenter.nl/best_practices/licensing.html notice>;`
安装
----
要安装DeepData_Alpha,请执行以下操作:
…代码块::控制台
git克隆https://github.com/john/deepdata_alpha.git
cd deepdata_alpha
pip安装。
代码块::控制台_自述文件:
在此处包括项目完整文档的链接。
contribution
********
如果您想为开发deepdata阿尔法做出贡献,
请查看"贡献指南<;contribution.rst>;`.
许可证
**
版权所有(C)2018,John J.H.Lin
credits
*****
此包是使用"cookiecutter<;https://github.com/audreyr/cookiecutter>;``和"nlesc/python模板"<;https://github.com/nlesc/python template>;``创建的。
deepdata_alpha
################################################################################
The package is for developing algorithm in prediction.
Project Setup
*************
Here we provide some details about the project set起来。大多数选择在"guide<;https://guide.esciencecenter.nl>;"中解释。相关章节的链接如下所示。
当软件包的开发开始时,请随意删除此文本。
有关软件开发的快速参考,请参阅"软件指南检查表"<;https://guide.esciencecenter.nl/best\u practices/checklist.html>;`.
版本控制
------
创建python包后,将其置于
`version control<;https://guide.esciencecenter.nl/best\u practices/version\u control.html>;`!
我们建议使用"git<;http://git scm.com/>;``和"github<;https://github.com/>;```.
代码块::console
git add-a
git commit
ython版本:
*3.4
*3.5
*3.6
>根据项目需求添加或删除python版本。`指南<;https://guide.esciencecenter.nl/best_practices/language_guides/python.html>;```包含有关python版本和编写python 2和3兼容代码的更多信息。
包管理和依赖项包裹管理。由于项目需求不同,此存储库不会强制您使用其中一个或另一个。如需有关使用方法的建议,请查看"指南的相关部分"https://guide.esciencecenter.nl/best-practices/language-guides/python.html"依赖项和包管理"` ` `.
*应将依赖项添加到"install-requires"列表中的"setup.py"中。
packaging/one command install-----
您可以使用pipy或conda分发代码。同样,项目模板不强制使用任何一个。`指南<;https://guide.esciencecenter.nl/best廑u practices/language廑guides/python.html廑building and packaging code>;``可以帮助您决定要使用哪种工具进行打包。
测试和代码覆盖率
----
*测试应放在"测试"文件夹中。
*tests`文件夹包含:
-e例如,您应该用自己有意义的测试(文件:`` test_deepdata_alpha``)
-检查代码是否符合python样式指南(pep 8)的测试(文件:`` test_lint.py`)
*使用的测试框架是`pytest<;https://pytest.org>;`` py
-`pytest introduction<;http://python testing.net/framework/py test/pytest introduction/>;``u
*测试可以使用``python setup.py test``
-这在``setup.py``和``setup.cfg`
*使用`travis ci<;https://travis ci.com/>;``自动运行测试并使用多个python版本进行测试
-配置可以在`.t中找到ravis.yml``
-` travis ci入门<;https://docs.travis ci.com/user/getting started/>;`
*todo:添加一些关于代码质量/覆盖率工具的内容?
*《指南》中的相关章节<;https://guide.esciencecenter.nl/best戋u practices/language戋guides/python.html戋testing>;`戋
文档
----
*文档应放在"docs"文件夹中。内容是用"sphinx"生成的-quickstart``(sphinx版本1.6.5)。
*我们建议使用重组文本(rest)和谷歌风格的docstring编写文档。
-`重组文本(rest)和sphinx备忘表<;http://openalea.gforge.inria.fr/doc/openalea/doc//build/html/source/sphinx/rest_syntax.html>;`
-`谷歌风格的文档字符串示例<;http://sphinxcontrib napoleon.read the docs.io/en/latest/example撸google.html>;``.
*文档设置为读取文档sphinx主题。
-查看"配置选项"<;https://sphinx-rtd-theme.readthedocs.io/en/latest/>;` `.
*要生成HTML文档,请运行``python setup.py build_sphinx``
-这在``setup.cfg`
-或者,在``docs``文件夹中运行``make html`.
*docs/u templates`目录包含一个(空)`.gitignore``file,以便能够将其添加到存储库中。可以安全地删除此文件(或者您可以将其保留在那里)。
*若要将文档放在"读取文档"上,请登录到"读取文档"帐户,然后导入存储库(在"我的项目"下)。
-在此区域中包括指向文档的链接dme'.
*`指南中的相关章节<;https://guide.esciencecenter.nl/best_practices/language_guides/python.html writingdocumentation>;`
编码风格惯例和代码质量
--------
*使用"潜在客户"检查您的代码风格或者`
*您可能需要运行``pip install.[dev]``首先,要安装所需的依赖项
*您可以使用``yapf``修复代码样式的可读性,并使用``isort``格式化和分组导入
*`指南中的相关部分<;https://guide.esciencecenter.nl/best\u practices/语言指南/python.html编码风格惯例>;`
package version number
----
*我们建议使用"语义版本控制"<;https://guide.esciencecenter.nl/best_u practices/releases.html语义版本控制>;`
*为方便起见,软件包版本SION存储在一个地方:``deepdata\u alpha/\u version\uuuu.py``。要更新版本号,只需更改此文件。
*在"发布"之前,请不要忘记更新版本号,lt;https://guide.esciencecenter.nl/best戋u practices/releases.html>;`!
changelog.rst
----
*文档对您的软件包的更改
*`指南中的相关部分<;https://guide.esciencecenter.nl/software/releases.html changelogmd>;`
引文.cff
----
dd a``citation.cff``文件
*只有在有要引用的东西(例如,带有doi的软件发行版)时才有意义。
*遵循指南中的"使软件可引用"部分:https://guide.esciencecenter.nl/citable\u software/making\u software\citable.html>;``。
cod行为规范。rst
----
*关于如何表现专业行为的信息
*`指南中的相关章节<;https://guide.esciencecenter.nl/software/documentation.html行为规范>;`
*关于H的信息如何为本软件包贡献
*`指南中的相关部分<;https://guide.esciencecenter.nl/software/documentation.html贡献指南>;`
manifest.in
——
*列出应包含在源发行版中的非python文件
*`指南中的相关章节<;https://guide.esciencecenter.nl/best_practices/language_guides/python.html构建和打包代码>;`
注意
----
*此项目的属性列表和apache许可依赖关系
*`指南中的相关章节<;https:。//guide.esciencecenter.nl/best_practices/licensing.html notice>;`
安装
----
要安装DeepData_Alpha,请执行以下操作:
…代码块::控制台
git克隆https://github.com/john/deepdata_alpha.git
cd deepdata_alpha
pip安装。
代码块::控制台_自述文件:
在此处包括项目完整文档的链接。
contribution
********
如果您想为开发deepdata阿尔法做出贡献,
请查看"贡献指南<;contribution.rst>;`.
许可证
**
版权所有(C)2018,John J.H.Lin
credits
*****
此包是使用"cookiecutter<;https://github.com/audreyr/cookiecutter>;``和"nlesc/python模板"<;https://github.com/nlesc/python template>;``创建的。