基于插件的组件建模工具。
TheLandlab的Python项目详细描述
| package name: | TheLandlab |
|---|---|
| Version: | 0.1 |
| release date: | 2013-03-24 |
| Authors: | Greg Tucker
Nicole Gasparini Erkan Istanbulluoglu Daniel Hobley Sai Nudurupati Jordan Adams Eric Hutton |
| url: | http://csdms.colorado.edu/trac/landlab |
| license: | MIT |
安装
安装释放装置
我们还没有释放房东，所以现在不行。 然而，一旦我们有了一个稳定的版本，这就是用户将如何安装我们的 他们机器上的软件：
$ pip install TheLandlab
这将安装LANDAB以及任何必备软件包（必需软件包 在setup.py）中列出。
从源发行版安装
从源发行版安装landab包（如 subversion签出），使用install参数运行setup.py脚本：
$ python setup.py install
这将把LANDAB软件包放在系统范围内，这样您就可以 从任何python会话导入landab。它还将安装任何所需的 包装。
注意，如果你是发展陆战队，你可能不想这样做！ 如果这样做，则每次更改为 密码。相反，您希望以“开发模式”安装包。见 下面的“开发环境”部分将详细介绍如何执行此操作。
开发固定资产
本节描述了开发LANDAB时的一个可能的工作流程。
使用Subversion
Subversion“版本控制与Subversion”书籍的标准资源。 它可以在线使用，而且完全免费！
签出源的副本
使用Subversion签出最新版本的源代码：
$ svn co https://csdms.colorado.edu/svn/TheLandlab/trunk landlab
或者，如果您已经有了存储库的工作副本，则可能需要 要使用其他人已提交给存储库的更改来更新它：
$ svn update
查看您的更改
现在您已经更改了一些文件，您可能希望 看看你做了什么。看看你上一次换了什么 提交（或自上次签出后），使用status命令：
$ svn status
使用subversion diff命令查看副本和 复制您签出的文件：
$ svn diff <changed_file>
其中<；changed_file>；是您更改的文件的名称。如果你 不列出任何文件名，此命令将打印all 有更改的文件。
将更改提交到存储库
一旦您对源代码的副本进行了更改并对 更改，您可以将其提交回存储库：
$ svn commit
这将提交您在当前目录下所做的所有更改。如果 您只想提交对一两个文件的更改，可以列出文件名 分别在命令行上：
$ svn commit <one_file> <another_file>
开发环境
一旦我有了LandleAB源代码的工作副本，我就使用pip命令来 安装代码的开发版本。如果我在基地的话 （包含setup.py的文件夹），我运行以下命令：
$ pip install -e .
这将设置python，以便在尝试 导入它-不管你在哪个目录。这允许python命令 例如：
>>> import landlab >>> from landlab import craters
去工作。如果不这样做，可能会出现包含 例如：
ImportError: No module named landlab
要卸载开发版本的landab:
$ pip uninstall TheLandlab
运行单元测试
在更新代码的工作副本（或签出新的 版本）我通常会运行包的单元测试，以确保没有 坏了。您可以使用setup.py:
$ python setup.py test
您可能还应该在将更改提交到存储库之前执行此操作 确保你没有弄坏东西。
编码方式
因为Python是如此灵活的风格，请尽量坚持编码 设计风格由PEP8编写，
http://www.python.org/dev/peps/pep-0008/
一个简单的方法是运行pep8命令来确保您已经完成了这项工作 在您编辑的每个文件上。如果你没有安装PEP8，你将不得不 安装时使用：
$ pip install pep8
现在可以在python源文件上运行它。例如：
$ pep8 craters.py
首先，这可能会返回许多源文件的问题。不要 不过，担心的是，很快就会习惯这种编码风格，并且能够 编写兼容的代码。如果我们坚持这一点，它将使 更容易阅读我们任何一个人写的代码。
构建API文档
您可以使用sphinx为landab api构建文档。一旦你准备好了 在你的环境中正确地导入LANDAB，你可以生成 sphinx文件具有：
$ python setup.py build_sphinx
这将把一堆文件放在docs文件夹中。HTML文档将 在docs/u build/html/文件夹下。将浏览器指向index.html 在此文件夹下，将为您提供文档的顶级页面。这 整个文件夹都是可重定位的，因此如果您希望将文档放在其他位置 你可以很容易地移动文件夹。
如果添加、删除或重命名了文件，则可能需要重新生成 sphinx文件并重新生成api文档。如果你安装了狮身人面像，你可以 使用（从包含setup.py的目录中）：
$ sphinx-apidoc -o docs landlab
快乐的房东！
欢迎加入QQ群-->： 979659372
