{
    "info": {
        "author": "Mathew Topper",
        "author_email": "dataonlygreater@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Natural Language :: English",
            "Programming Language :: Python :: 2.7",
            "Topic :: Scientific/Engineering"
        ],
        "description": "convergence\r\n===========\r\n\r\nA Python program to Perform Calculations Associated with a Grid\r\nConvergence Study.\r\n\r\nIntroduction\r\n------------\r\n\r\nThis is a port of verify.f90, a program provided as part of the NASA\r\nExamining Spatial (Grid) Convergence tutorial.\r\n\r\nhttp://www.grc.nasa.gov/WWW/wind/valid/tutorial/spatconv.html\r\n\r\nAdditional changes have been made to reflect the recommendations in:\r\n\r\nCelik, I. B., Ghia, U., & Roache, P. J. (2008). Procedure for estimation\r\nand reporting of uncertainty due to discretization in CFD applications.\r\nJournal of fluids Engineering-Transactions of the ASME, 130(7).\r\n\r\nThis code was written by Mathew Topper between 2009 and 2011 as part of\r\nthe Supergen Marine Research Consortium project. I was younger then and\r\nwould do many things differently now. I am working on updating this code\r\nto make the main class and functions more easy to use and also integrate\r\ninto other projects. Watch this space.\r\n\r\nInstallation\r\n------------\r\n\r\nThe package requires no dependencies, but is currently only available\r\nfor Python 2.7.\r\n\r\nThe package can be installed by downloading the source code, and using a\r\nterminal or command prompt as follows:\r\n\r\n::\r\n\r\n    cd /path/to/convergence\r\n    python setup.py install\r\n\r\nThe package can also be downloaded from PyPI, again using a terminal or\r\ncommand prompt:\r\n\r\n::\r\n\r\n    pip install convergence\r\n\r\nBasic Usage\r\n-----------\r\n\r\nThe package provides a command line interface which is the main (and\r\ncurrently only sensible) way to use the package. The input data must be\r\na space delimeted text file with the first column being the grid spacing\r\nand the second column being the metric of interest. An example can be\r\nfound in the *data* folder of the source code.\r\n\r\nThe program can then be executed as follows:\r\n\r\n::\r\n\r\n    grid-convergence /path/to/data/file\r\n\r\nBy default, the results of the program are written to a file called\r\n*verify\\_report.txt* in the calling directory. The file name can be\r\nchanged using the *-o* or *--out* command line options. The format of\r\nthe file is as follows:\r\n\r\n::\r\n\r\n    --- VERIFY: Performs verification calculations --- \r\n\r\n    Number of grids to be examined = 3 \r\n\r\n         Grid Size     Quantity \r\n\r\n         1.000000      0.970500 \r\n         2.000000      0.968540 \r\n         4.000000      0.961780 \r\n\r\n\r\n    Discretisation errors for fine grids:\r\n\r\n           Grids |     e_approx |     e_extrap |      f_exact |   gci_coarse | \r\n     =========================================================================\r\n           1 2 3 |     0.002020 |     0.000824 |     0.971300 |     0.003555 | \r\n     -------------------------------------------------------------------------\r\n\r\n           Grids |     gci_fine |            p |          r21 |          r32 | \r\n     =========================================================================\r\n           1 2 3 |     0.001031 |     1.786170 |     2.000000 |     2.000000 | \r\n     -------------------------------------------------------------------------\r\n\r\n\r\n    Discretisation errors for coarse grids:\r\n\r\n           Grids |     e_approx |     e_extrap |      f_exact |   gci_coarse | \r\n     =========================================================================\r\n           1 2 3 |     0.006980 |     0.002842 |     0.971300 |     0.012287 | \r\n     -------------------------------------------------------------------------\r\n\r\n           Grids |     gci_fine |            p |          r21 |          r32 | \r\n     =========================================================================\r\n           1 2 3 |     0.003562 |     1.786170 |     2.000000 |     2.000000 | \r\n     -------------------------------------------------------------------------\r\n\r\n\r\n    Asympototic ratio test:\r\n\r\n               Grids | Asymptotic ratio | \r\n     ====================================\r\n               1 2 3 |         0.997980 | \r\n     ------------------------------------\r\n\r\n\r\n    --- End of VERIFY --- \r\n\r\nIn the first table the input data is displayed. The second table shows\r\nthe fine analysis results for each trio of grids and the second table\r\nshows the coarse analysis results for each trio. The final table shows\r\nthe asymptotic ratio.\r\n\r\nThe headers of the tables have the following meanings:\r\n\r\n-  **Grids**: the trio of grids being analysed\r\n-  **e\\_approx**: approximate relative error\r\n-  **e\\_extrap**: extrapolated relative error\r\n-  **f\\_exact**: the estimated the zero grid spacing value\r\n-  **gci\\_coarse**: coarse grid convergence index\r\n-  **gci\\_fine** fine grid convergence index\r\n-  **p**: order of convergence\r\n-  **r21**: ratio of the middle to fine grid spacing\r\n-  **r32**: ratio of the coarse to middle grid spacing\r\n\r\nKnown Analytical Result\r\n-----------------------\r\n\r\nIf there is a known zero spacing value for the convergence study this\r\nvalue can be added to the analysis using the *-a* or *--analytical*\r\ncommand line option. To illustrate, the basic example would now become:\r\n\r\n::\r\n\r\n    grid-convergence /path/to/data/file -a 0.12345\r\n\r\nAdditional headers now appear in the fine and coarse analysis tables\r\nwith the following meanings:\r\n\r\n-  **e\\_analytic**: analytical relative error\r\n-  **f\\_analytic**: the analytical the zero grid spacing value\r\n-  **f\\_delta**: the different between the analytical and estimated zero\r\n   grid spacing value\r\n\r\n\r\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/H0R5E/convergence",
        "keywords": "",
        "license": "GPLv3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "convergence",
        "package_url": "https://pypi.org/project/convergence/",
        "platform": "",
        "project_url": "https://pypi.org/project/convergence/",
        "project_urls": {
            "Homepage": "https://github.com/H0R5E/convergence"
        },
        "release_url": "https://pypi.org/project/convergence/0.1/",
        "requires_dist": null,
        "requires_python": "==2.7.*",
        "summary": "A Python program to Perform Calculations Associated with a Grid Convergence Study",
        "version": "0.1"
    },
    "last_serial": 3235682,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4c5f51ce735ed52e97a5a457cb2cee89",
                    "sha256": "cc468d3b7d26b0315e957fb5d558a381d33c4a5951fbe0e5afe61e3d10d279c8"
                },
                "downloads": -1,
                "filename": "convergence-0.1-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "4c5f51ce735ed52e97a5a457cb2cee89",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": "==2.7.*",
                "size": 17293,
                "upload_time": "2017-10-09T08:31:59",
                "url": "https://files.pythonhosted.org/packages/11/c9/586c85f24e4f428f55c69903c1837a04d52d029a5e58ee178a67fa01f931/convergence-0.1-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d2f46b75489ec5a03cd1067404883d16",
                    "sha256": "1895baf2cf3cb230b3c2b2377b7d499df6792040ba958cad3b202fc9edbae0eb"
                },
                "downloads": -1,
                "filename": "convergence-0.1.win-amd64.zip",
                "has_sig": false,
                "md5_digest": "d2f46b75489ec5a03cd1067404883d16",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": "==2.7.*",
                "size": 67879,
                "upload_time": "2017-10-09T08:32:02",
                "url": "https://files.pythonhosted.org/packages/1b/4a/a080a47befbe2ccf42907a0dbff5680d9e155a3d7ed5a06ea8eaf2d329ca/convergence-0.1.win-amd64.zip"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4c5f51ce735ed52e97a5a457cb2cee89",
                "sha256": "cc468d3b7d26b0315e957fb5d558a381d33c4a5951fbe0e5afe61e3d10d279c8"
            },
            "downloads": -1,
            "filename": "convergence-0.1-py2-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c5f51ce735ed52e97a5a457cb2cee89",
            "packagetype": "bdist_wheel",
            "python_version": "py2",
            "requires_python": "==2.7.*",
            "size": 17293,
            "upload_time": "2017-10-09T08:31:59",
            "url": "https://files.pythonhosted.org/packages/11/c9/586c85f24e4f428f55c69903c1837a04d52d029a5e58ee178a67fa01f931/convergence-0.1-py2-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d2f46b75489ec5a03cd1067404883d16",
                "sha256": "1895baf2cf3cb230b3c2b2377b7d499df6792040ba958cad3b202fc9edbae0eb"
            },
            "downloads": -1,
            "filename": "convergence-0.1.win-amd64.zip",
            "has_sig": false,
            "md5_digest": "d2f46b75489ec5a03cd1067404883d16",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "==2.7.*",
            "size": 67879,
            "upload_time": "2017-10-09T08:32:02",
            "url": "https://files.pythonhosted.org/packages/1b/4a/a080a47befbe2ccf42907a0dbff5680d9e155a3d7ed5a06ea8eaf2d329ca/convergence-0.1.win-amd64.zip"
        }
    ]
}