{ "info": { "author": "Eric Hutton", "author_email": "eric.hutton@colorado.edu", "bugtrack_url": null, "classifiers": [], "description": "===========\nThe Landlab\n===========\n\n:package name: TheLandlab\n:version: 0.1\n:release date: 2013-03-24\n:authors:\n Greg Tucker,\n Nicole Gasparini,\n Erkan Istanbulluoglu,\n Daniel Hobley,\n Sai Nudurupati,\n Jordan Adams,\n Eric Hutton\n\n:url: http://csdms.colorado.edu/trac/landlab\n\n:license: MIT\n\nInstall\n=======\n\nInstalling a release\n--------------------\n\nWe don't have any releases of The Landlab yet so this doesn't work right now.\nHowever, once we have a stable release, this is how users will install our\nsoftware on their machine::\n\n $ pip install TheLandlab\n\nThis will install Landlab as well as any prerequisite packages (required packages\nare listed in setup.py).\n\nInstalling from a source distribution\n-------------------------------------\n\nTo install the landlab package from a source distribution (like what you get with\na Subversion checkout), run the setup.py script with the install argument::\n\n $ python setup.py install\n\nThis will put the landlab package into a system-wide location so that you can\nimport landlab from any python session. It will also install any required\npackages.\n\nNote that if you are developing landlab you will probably not want to do this!\nIf you do, you would have to run this command everytime you make a change to\nthe code. Instead, you want to install the package in \"development mode\". See\nbelow in the \"Development Environment\" section for details on how to do this.\n\n\n----------------------\nDeveloping The Landlab\n----------------------\n\nThis section describes one possible workflow when developing The Landlab.\n\nUsing Subversion\n================\n\nThe standard resource for Subversion \"Version Control with Subversion\" book.\nIt's available online and is completely *free*!\n\nhttp://svnbook.red-bean.com/\n\n\nCheckout a copy of the source\n-----------------------------\n\nUse Subversion to checkout the latest version of the source code::\n\n $ svn co https://csdms.colorado.edu/svn/TheLandlab/trunk landlab\n\nAlternatively, if you already have a working copy of the repository you may want\nto update it with changes that others have committed to the repository::\n\n $ svn update\n\nReview your changes\n-------------------\n\nNow that you've made changes to some files, you'll probably want to have a\nlook at what you've done. To see what it is you've changed since your last\ncommit (or since you last checkout), use the status command::\n\n $ svn status\n\nUse the Subversion diff command to see the differences between your copy and the\ncopy that you checked out::\n\n $ svn diff \n\nwhere ** is the name of the file you've made changes to. If you\ndon't list any file names, this command will print the differences for *all*\nfiles that have changes.\n\nCommit your changes to the repository\n-------------------------------------\n\nOnce you have made changes to your copy of the source and are happy with the\nchanges, you can commit them back to the repository::\n\n $ svn commit\n\nThis will commit all changes that you have made under the current directory. If\nyou only want to commit changes to a file or two, you can list the file names\nseparately on the command line::\n\n $ svn commit \n\n\n---------------------------\nThe Development Environment\n---------------------------\n\nOnce I have a working copy of The Landlab source code, I use the pip command to\ninstall a development version of the code. If I'm in the base landlab folder\n(the folder that contains setup.py), I run the following::\n\n $ pip install -e .\n\nThis sets up python so that it knows where the landlab package is when try to\nimport it - regardless of what directory you are in. This allows python commands\nlike::\n\n >>> import landlab\n >>> from landlab import craters\n\nto work. If you didn't do this you might start getting errors that contain \nsomething like::\n\n ImportError: No module named landlab\n\nTo uninstall your development version of landlab::\n\n $ pip uninstall TheLandlab\n\n\n------------------\nRunning Unit Tests\n------------------\n\nImmediatly after update your working copy of the code (or checking out a new\nversion) I will normally run the unit tests for the package to make sure nothing\nis broken. You can do this with setup.py::\n\n $ python setup.py test\n\nYou should also probably do this before commiting changes to the repository to\nmake sure you didn't break things.\n\n\n------------\nCoding Style\n------------\n\nBecause Python is so flexible style-wise, please try to stick to the coding\nstyle described by PEP8,\n\nhttp://www.python.org/dev/peps/pep-0008/\n\nAn easy way to make sure that you've done this is by running the pep8 command\non each file that you edit. If you don't have pep8 installed, you will have to\ninstall it with::\n\n $ pip install pep8\n\nNow you can run it on a Python source file. For instance::\n\n $ pep8 craters.py\n\nAt first, this will probably return lots of problems with you source file. Don't\nworry though, it won't take long to get used to the coding style and be able to\nwrite compatible code straigt away. If we stick to this it will make it much\neasier to read the code written by any one of us.\n\n\n-----------------------\nBuild API Documentation\n-----------------------\n\nYou can build documentation for the LandLab API using Sphinx. Once you have set\nup your envrionment to properly import landlab, you can generate the necessary\nsphinx files with::\n\n $ python setup.py build_sphinx\n\nThis will put a bunch of files in the docs folder. The HTML documentation will\nbe under the docs/_build/html/ folder. Pointing your browser to index.html\nunder this folder will give you the top-level page for the documentation. This\nentire folder is relocatable, so if you would like your documentation elsewhere\nyou can easily move the folder around.\n\nIf you have added, removed, or renamed files you may need to regenerate some of\nthe sphinx files and rebuild the api docs. If you have Sphinx installed, you can\ndo this with (from the directory that contains setup.py)::\n\n $ sphinx-apidoc -o docs landlab\n\n\nHappy Landlab-ing!\n==================", "description_content_type": null, "docs_url": "https://pythonhosted.org/TheLandlab/", "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://csdms.colorado.edu/trac/landlab", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "TheLandlab", "package_url": "https://pypi.org/project/TheLandlab/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/TheLandlab/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://csdms.colorado.edu/trac/landlab" }, "release_url": "https://pypi.org/project/TheLandlab/0.1.5/", "requires_dist": null, "requires_python": null, "summary": "Plugin-based component modeling tool.", "version": "0.1.5" }, "last_serial": 1456542, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1501e9e8af9590f46d4bc30178dd327e", "sha256": "81c7a95762b1b89688eba8787944913c8cb7d49a0c17aa942a97c1463df8ec3f" }, "downloads": -1, "filename": "TheLandlab-0.1.0.tar.gz", "has_sig": false, "md5_digest": "1501e9e8af9590f46d4bc30178dd327e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4571617, "upload_time": "2013-12-20T17:22:13", "url": "https://files.pythonhosted.org/packages/0c/26/88d4b3c9ba00be5fa683e987dcaaa4cfa6ce74d594e5c3c4246f11be4029/TheLandlab-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "680fe036597bb920b4b8758c6661f1f2", "sha256": "61529f364b0c3146c32b55a6a326ba39168f99389862461b74d8d888a93c0ba1" }, "downloads": -1, "filename": "TheLandlab-0.1.1.tar.gz", "has_sig": false, "md5_digest": "680fe036597bb920b4b8758c6661f1f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2285896, "upload_time": "2013-09-05T05:14:59", "url": "https://files.pythonhosted.org/packages/82/03/accf5ee02a39a170e1437b498f052a0f4bf1732bf4a8fbaf5ca44abd2e07/TheLandlab-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "f44c347aee2b6db188e5a2ae14635dcc", "sha256": "6180028f5153c3358702a3c3249ad7d93539f02f132090834014d09e873f94a6" }, "downloads": -1, "filename": "TheLandlab-0.1.2.tar.gz", "has_sig": false, "md5_digest": "f44c347aee2b6db188e5a2ae14635dcc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4571648, "upload_time": "2013-12-20T17:25:45", "url": "https://files.pythonhosted.org/packages/9b/8f/ce3b095b1c6cde5a484a09cae77da957ecc30275ccf2dc2ef59f135607e1/TheLandlab-0.1.2.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "9ac1daf02d6c592a66375f481d98d441", "sha256": "32867ebd7a9dc83a1fb6fc19086e622d2ad82da5c77032ea1a726ce0fce26646" }, "downloads": -1, "filename": "TheLandlab-0.1.4.tar.gz", "has_sig": false, "md5_digest": "9ac1daf02d6c592a66375f481d98d441", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4627436, "upload_time": "2014-03-12T02:51:40", "url": "https://files.pythonhosted.org/packages/1a/62/fca2740577793e767f7bd715bf1b79d0f698629524a07e105617fda6597e/TheLandlab-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "built for Darwin-14.0.0", "digests": { "md5": "51743f3a4fd5b26772c6c89cf324c9af", "sha256": "f2b7955e39cefa31a765245da21a5057dc2032f49c463f627c8b93c038b7d799" }, "downloads": -1, "filename": "TheLandlab-0.1.5.macosx-10.5-x86_64.tar.gz", "has_sig": false, "md5_digest": "51743f3a4fd5b26772c6c89cf324c9af", "packagetype": "bdist_dumb", "python_version": "2.7", "requires_python": null, "size": 728583, "upload_time": "2015-03-10T21:58:37", "url": "https://files.pythonhosted.org/packages/bf/e2/0c47bb5737936fc6825fe14451286604899f4fc7ce31368c3116c45f548c/TheLandlab-0.1.5.macosx-10.5-x86_64.tar.gz" }, { "comment_text": "", "digests": { "md5": "ecc28f6697b2604cbd133d615a867d8a", "sha256": "e0b42d02391a8a5d2a6699f7ef22a17b039a6f98d3d7651eb9886b54936553cd" }, "downloads": -1, "filename": "TheLandlab-0.1.5-py2.7-macosx-10.5-x86_64.egg", "has_sig": false, "md5_digest": "ecc28f6697b2604cbd133d615a867d8a", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 960853, "upload_time": "2015-03-10T22:18:33", "url": "https://files.pythonhosted.org/packages/a4/a1/4da6ebea2403c38cc2d31b93589d79d862716206f8bf96a717f14b5e2d0a/TheLandlab-0.1.5-py2.7-macosx-10.5-x86_64.egg" } ] }, "urls": [ { "comment_text": "built for Darwin-14.0.0", "digests": { "md5": "51743f3a4fd5b26772c6c89cf324c9af", "sha256": "f2b7955e39cefa31a765245da21a5057dc2032f49c463f627c8b93c038b7d799" }, "downloads": -1, "filename": "TheLandlab-0.1.5.macosx-10.5-x86_64.tar.gz", "has_sig": false, "md5_digest": "51743f3a4fd5b26772c6c89cf324c9af", "packagetype": "bdist_dumb", "python_version": "2.7", "requires_python": null, "size": 728583, "upload_time": "2015-03-10T21:58:37", "url": "https://files.pythonhosted.org/packages/bf/e2/0c47bb5737936fc6825fe14451286604899f4fc7ce31368c3116c45f548c/TheLandlab-0.1.5.macosx-10.5-x86_64.tar.gz" }, { "comment_text": "", "digests": { "md5": "ecc28f6697b2604cbd133d615a867d8a", "sha256": "e0b42d02391a8a5d2a6699f7ef22a17b039a6f98d3d7651eb9886b54936553cd" }, "downloads": -1, "filename": "TheLandlab-0.1.5-py2.7-macosx-10.5-x86_64.egg", "has_sig": false, "md5_digest": "ecc28f6697b2604cbd133d615a867d8a", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 960853, "upload_time": "2015-03-10T22:18:33", "url": "https://files.pythonhosted.org/packages/a4/a1/4da6ebea2403c38cc2d31b93589d79d862716206f8bf96a717f14b5e2d0a/TheLandlab-0.1.5-py2.7-macosx-10.5-x86_64.egg" } ] }