{ "info": { "author": "Nick Barnes, David Jones", "author_email": "ccc-gistemp@climatecode.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Education", "Topic :: Scientific/Engineering", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "CLEAR CLIMATE CODE GISTEMP README FOR RELEASE 0.6.1\n\nNick Barnes, Climate Code Foundation\nDavid Jones, Climate Code Foundation\n\n$Date: 2011-06-01 16:08:26 -0400 (Wed, 01 Jun 2011) $\n\n\nCONTENTS\n\n 1. Introduction\n 2. Dependencies\n 3. Installation\n 4. Input Data\n 5. Running\n 6. Results\n 7. Regression Testing\n A. References\n B. Document history\n C. Copyright and license\n\n1. INTRODUCTION\n\nThis is release 0.6.1 of the Clear Climate Code GISTEMP project\n(ccc-gistemp).\n\nClear Climate Code have reimplemented GISTEMP (the GISS surface\ntemperature analysis system), to make it clearer. Work continues\ntowards making it more clear and more accessible.\n\nccc-gistemp release 0.6.1 is a release of ccc-gistemp version 0.6.\nThe purpose of version 0.6 is to make ccc-gistemp more useful by:\n - allowing more flexible choices of input data. For example: GHCN v3;\n USHCN only; ocean only.\n - allowing a land mask to be used in the step where land and ocean\n data are combined.\n - making use on NumPy array.\n - adding a setup.py\n\nIn addition there are various bug fixes and improvements to clarity.\n\nChanges since earlier releases are described in more detail in\nrelease-notes.txt.\n\nURLs for further information:\n\nhttp://clearclimatecode.org/ Clear Climate Code website and blog.\nhttp://ccc-gistemp.googlecode.com/ ccc-gistemp code repository.\n\n\n2. DEPENDENCIES\n\nYou need Python and a machine that can run it, and a network\nconnection; there are no explicit operating system or CPU architecture\ndependencies so \"any\" operating system or CPU should be okay.\n\nPython comes in several versions. We recommend Python 2.6 or Python\n2.7, but ccc-gistemp should work on any version of Python from the\n2.x branch (since 2.4). It will not work with Python 3.x (which\npython.org calls \"shiny new thing\"). Support for Python 2.4 (and\nto some extent 2.5) remains fragile, and it has caused some problems\nin the past.\n\nThe code should run on OS X, FreeBSD, Windows, and probably a variety of\nother Unix-like operating systems.\n\nA network connection is required to download the input files (which\nneed only be done once), and to display an optional graph from the\nresults. If you use a proxy to access the internet then Python requires\nthat the \"http_proxy\" environment variable is set. The proxy will need\nto handle both HTTP and FTP requests (this seems to cause some trouble,\nsee \"INPUT DATA\" below for downloading data by hand).\n\nPython may already be installed on your machine (for example, it comes\npre-installed on OS X), it may be possible to install it using your\noperating system's package manager; for Windows you can download an\ninstaller from http://www.python.org/download/ . We recommend you use a\nstable production release from the Python 2.x series (Python 3.x will\nnot work).\n\n\n3. INSTALLATION\n\nUnpack ccc-gistemp-0.6.1.tar.gz.\n\n\n4. INPUT DATA\n\nccc-gistemp uses input data in the subdirectory input/. This\ninput data includes large files (a few megabytes to a few dozen\nmegabytes) of temperature records from GHCN, USHCN, and sea surface\ndata, and small files of additional temperature records and station\ntables from GISS. ccc-gistemp includes code (tool/preflight.py)\nto fetch this data from the originating organisations over the\ninternet. It will not download a file if it is already present in\nthe input/ directory, so if you wish to run ccc-gistemp with updated\ninput data, you can delete the input/ directory before you start.\n\nDownloading the input data is a common causes of problems. Maintaining\nthe part of the code that does this (which has nothing to do with the\ncore GISTEMP algorithm) is a significant cost. If the tools\nwe provide do not seem to download the input data correctly, you can\ndownload the data \"by hand\" and install it in the input/ directory. See\ndoc/input.txt for more details.\n\n\n5. RUNNING\n\nTo run ccc-gistemp:\n\n python tool/run.py\n\nThat command runs steps 0 through 5. To run only a single step or a shorter\nsequence of steps, use the -s argument. For instance:\n\n python tool/run.py -s 3 # Runs just step 3\n python tool/run.py -s 0-3,5 # Runs steps 0,1,2,3,5 (omitting 4)\n\nWe use this directory structure:\n\nccc-gistemp-x.x.x/code/ Source code for the GISTEMP algorithm only\n /config/ Configuration files\n /doc/ Internal developer documentation\n /input/ Input data files\n /log/ Log files\n /tool/ Tools - sources other than the GISTEMP algorithm\n /work/ Intermediate data files\n /result/ Final result files\n\nRunning the code should write to the input/ directory when fetching\ninput data, but subsequently only write to the work/ log/ and result/\ndirectories. Before running tool/run.py, these directories can all be\ndeleted (if you wish, for example, to have a clean run).\n\nIn 2011 a complete run takes about 35 minutes on an Amazon EC2 \"High-CPU\nMedium Instance\" which is a bit faster than the sorts of not-very-impressive\nmachines that the developers use. If you want this to go much\nfaster we recommend that you run using PyPy (an alternate implementation\nof Python http://codespeak.net/pypy/dist/pypy/doc/ ). See this note\nfrom Paul Ollis:\nhttp://groups.google.com/group/ccc-gistemp-discuss/browse_thread/thread/cb0409e770820680\n\n\n6. RESULTS\n\nAfter running run.py, the GISTEMP result files are all in the result/\ndirectory. A simple graphical chart is made using the Google Chart\nAPI; this file:\n\n result/google-chart.url\n\ncontains the URL of a chart showing the global annual mean surface\ntemperature anomaly.\n\nIf you have the results of two separate runs in two different\ndirectories, old-result/ and new-result/ , then an HTML report comparing\nthe two can be generated with this command:\n\n python tool/compare_results.py --labela=old --labela=new old-result new-result\n\nThis will produce a file called index.html in the current directory,\nincluding various statistical comparisons of the two result files.\n\n\n7. REGRESSION TESTING\n\nTo test ccc-gistemp against GISTEMP:\n\n python tool/regression.py\n\nThis will fetch a tarball from\nhttp://ccc-gistemp.googlecode.com/files/ccc-gistemp-test-2009-12-28.tar.gz\nand uncompress it to a local directory ccc-gistemp-test-2009-12-28/.\nThis contains input files and result data kindly provided to the\nccc-gistemp project by Dr Reto Ruedy of NASA GISS, from an actual run\nof GISTEMP at GISS on 2009-12-28. Once the tarball is fetched and\nunpacked, the local ccc-gistemp code will be run on it and the results\ncompared, generating a report in index.html.\n\nNote that there are indeed some changes between the results of the\nreference run and 0.4.1 (and subsequent versions), mainly caused\nby a change to the GISTEMP algorithm, for rural/urban station\ndistinction, made at GISS since the reference run. We have replicated\nthat change in ccc-gistemp (see\nhttp://ccc-gistemp.googlecode.com/issues/detail?id=54). To test\nccc-gistemp running the same algorithm as the reference GISTEMP\nrun, edit code/parameters.py to set use_global_brightness = False\nbefore running tool/regression.py.\n\n\nA. REFERENCES\n\nNone.\n\n\nB. DOCUMENT HISTORY\n\nMost recent changes first:\n\n2010-10-29 DRJ Updated to prepare for 0.6.1.\n2010-10-22 DRJ Updated to prepare for 0.6.0.\n2010-07-21 DRJ Updated to prepare for 0.5.1.\n2010-07-19 DRJ Updated to prepare for 0.5.0.\n2010-07-13 DRJ Added note about PyPy.\n2010-03-11 DRJ Updated to prepare for 0.4.1.\n2010-03-09 DRJ Updated to prepare for 0.4.0.\n2010-01-26 NB Updated to prepare for 0.3.0.\n2010-01-25 DRJ Removed PNG result.\n2010-01-22 NB Updated to reflect some code moving to tool/.\n2010-01-11 NB Updated to describe preflight better.\n2010-01-06 DRJ Updated for our all-Python status.\n2009-12-03 NB Updated for transfer to GoogleCode project.\n2008-09-19 DRJ Added PNG result.\n2008-09-13 NB Updated for CCC 0.1.0.\n2008-09-12 NB Updated for CCC 0.0.3.\n2008-09-12 NB Updated for CCC 0.0.2.\n2008-09-11 NB Updated for CCC 0.0.1.\n2008-09-08 NB Created.\n\n\nC. COPYRIGHT AND LICENSE\n\nThis document is copyright (C) 2009, 2010 Ravenbrook Limited; and (C)\n2010 Climate Code Foundation. All rights reserved.\n\nRedistribution and use of this document in any form, with or without\nmodification, is permitted provided that redistributions of this\ndocument retain the above copyright notice, this condition and the\nfollowing disclaimer.\n\nTHIS DOCUMENT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS\nIS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED\nTO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nDOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n$URL: https://ccc-gistemp.googlecode.com/svn/branches/2011-05-18/gsoc/readme.txt $\n$Rev: 772 $", "description_content_type": null, "docs_url": null, "download_url": "http://ccc-gistemp.googlecode.com/files/ccc-gistemp-0.6.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://code.google.com/p/ccc-gistemp/", "keywords": "science,climate,GIS,temperature", "license": "LICENSE.txt", "maintainer": null, "maintainer_email": null, "name": "ccc-gistemp", "package_url": "https://pypi.org/project/ccc-gistemp/", "platform": "any", "project_url": "https://pypi.org/project/ccc-gistemp/", "project_urls": { "Download": "http://ccc-gistemp.googlecode.com/files/ccc-gistemp-0.6.1.tar.gz", "Homepage": "http://code.google.com/p/ccc-gistemp/" }, "release_url": "https://pypi.org/project/ccc-gistemp/0.6.1/", "requires_dist": null, "requires_python": null, "summary": "ccc-gistemp is a reimplementation of GISTEMP in Python for clarity. GISTEMP is\na reconstruction of the global historical temperature record from land and sea\nsurface temperature records. It produces a familiar graph of historical\ntemperatures", "version": "0.6.1" }, "last_serial": 345036, "releases": { "0.6.1": [ { "comment_text": "", "digests": { "md5": "e11b5c696e63c80ca0d3f9b11e9f6602", "sha256": "8d1e46b4d07b9c5a31a83a70e8505376ba0cd71e36208108f0bff91e88f2804d" }, "downloads": -1, "filename": "ccc-gistemp-0.6.1.tar.gz", "has_sig": false, "md5_digest": "e11b5c696e63c80ca0d3f9b11e9f6602", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 188020, "upload_time": "2011-06-14T21:54:45", "url": "https://files.pythonhosted.org/packages/38/09/0896a327db71854beb211db02fbe4d4cde4fe4fd3a236299a86e648be88c/ccc-gistemp-0.6.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e11b5c696e63c80ca0d3f9b11e9f6602", "sha256": "8d1e46b4d07b9c5a31a83a70e8505376ba0cd71e36208108f0bff91e88f2804d" }, "downloads": -1, "filename": "ccc-gistemp-0.6.1.tar.gz", "has_sig": false, "md5_digest": "e11b5c696e63c80ca0d3f9b11e9f6602", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 188020, "upload_time": "2011-06-14T21:54:45", "url": "https://files.pythonhosted.org/packages/38/09/0896a327db71854beb211db02fbe4d4cde4fe4fd3a236299a86e648be88c/ccc-gistemp-0.6.1.tar.gz" } ] }