{
    "info": {
        "author": "YTB",
        "author_email": "student@g.harvard.edu",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "[![Build Status](https://travis-ci.org/flamespeed/cs207-FinalProject.svg?branch=master)](https://travis-ci.org/flamespeed/cs207-FinalProject.svg?branch=master)\n[![Coverage Status](https://coveralls.io/repos/github/flamespeed/cs207-FinalProject/badge.svg?branch=master&maxAge=0)](https://coveralls.io/github/flamespeed/cs207-FinalProject?branch=master&maxAge=0)\n\n# Flamespeed\n\n## What is Flamespeed?\n\nFlamespeed is the measured rate of expansion of the flame front in a combustion reaction.\n\nIt is also an open-source Python library with object-orientated methods for chemical kinetics with the following core functionality:\n\n* API to import a database of elementary reactions in XML-format\n* Efficiently calculate reaction rates for systems of irreversible elementary chemical reactions\n* Output provided in format suitable for further analysis\n\nPotential **applications** for Flamespeed includes:\n\n* Validation of chemical phase input files\n* Input for solving ODEs for system of reactions\n* Input for machine learning methods (e.g. neural networks) that predict reaction types\n\n## Installation\n\nThere are two ways to install Flamespeed:\n\n* **Install Flamespeed from PyPI (recommended)**\n\n```bash\npip3 install flamespeed\n```\n\n* **Alternatively: Install Flamespeed form Github source**\n\nFirst, clone Flamespeed using `git`:\n\n```sh\ngit clone https://github.com/flamespeed/cs207-FinalProject.git\n```\nThen, `cd` to the root folder and run the install command:\n```sh\npython setup.py install\n```\n\nThe package **test suite** can be run as follows:\n\nFirst, `cd` to the flamespeed folder and then run pytest:\n```sh\ncd flamespeed\npytest\n```\n\n**Requirements:**\n* Python (>= 3.3)\n* NumPy (>= 1.8.2)\n* SciPy (>= 0.13.3)\n\n\n## Getting started\n\nImport the `chemkin` module in flamespeed, which is the main module to evaluate chemical reaction rates.\n\n```python\nfrom flamespeed import chemkin\n```\nInstantiate the reaction rates class and import reaction database in XML format. Example reaction files can be found in the `./data` directory within `flamespeed`.\n\n```python\na = chemkin.ReactionRate()\na.read_XML('./flamespeed/data/rxns_reversible.xml')\nprint(a)\n```\nNext, set the initial concentrations for each of the species included in the reaction and the temperature.\n\n```python\na.set_temp(750)\nx = [2.0, 1.0, 0.5, 1.0, 1.0, 1.5, 0.5, 1]\n```\nNow that all the input parameters have been specified the reaction rates for each of the species in the system can be determined as follows:\n\n```python\nr = a.get_reaction_rate(x)\nprint(r)\n```\n\n## Documentation\n\nTechnical detail regarding the chemical theory underlying the reaction rate calculations and detailed documentation of the relevant classes and methods included in the Flamespeed package can be found in the `docs` directory:\n\nhttps://github.com/flamespeed/cs207-FinalProject/tree/master/docs",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/flamespeed/cs207-FinalProject/",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "flamespeed",
        "package_url": "https://pypi.org/project/flamespeed/",
        "platform": "",
        "project_url": "https://pypi.org/project/flamespeed/",
        "project_urls": {
            "Homepage": "https://github.com/flamespeed/cs207-FinalProject/"
        },
        "release_url": "https://pypi.org/project/flamespeed/1.0.1/",
        "requires_dist": null,
        "requires_python": ">=3",
        "summary": "Chemical kinetics library for Python",
        "version": "1.0.1"
    },
    "last_serial": 3408711,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a8d7abedb6fd3ed298f4550ab962ad70",
                    "sha256": "c84f889e67df2e98e4be9bf5d27a71fa6291078078bfec4f6c2d1874bed3be82"
                },
                "downloads": -1,
                "filename": "flamespeed-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a8d7abedb6fd3ed298f4550ab962ad70",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 7247,
                "upload_time": "2017-11-14T03:25:30",
                "url": "https://files.pythonhosted.org/packages/01/cc/1b3636b7b8511c763de9e5edfa6664939fb7bab80399aa354801affd15f8/flamespeed-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7e3b62ce3f686038953a1db52642d243",
                    "sha256": "4f8ae1aafb18d28b683ba78c4f4602db9bfd1bf8175be236fc334192c78bfbc0"
                },
                "downloads": -1,
                "filename": "flamespeed-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "7e3b62ce3f686038953a1db52642d243",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 11579,
                "upload_time": "2017-11-15T04:28:16",
                "url": "https://files.pythonhosted.org/packages/f9/7b/b0d385bb348b8f1d8389d758c730508ee7766e0e5afed895901c6efd05be/flamespeed-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d0c9eddb29984ddfc5383ac55293847d",
                    "sha256": "49c5159a083ff4bce471df3bb6e4def527201930b4e1d92fbd8896771f9685f0"
                },
                "downloads": -1,
                "filename": "flamespeed-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "d0c9eddb29984ddfc5383ac55293847d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 11549,
                "upload_time": "2017-11-15T18:17:35",
                "url": "https://files.pythonhosted.org/packages/8a/e5/cb922c47614e9ed16adbc9d75d972672b21bb8ca8e8c1497ebf6453b852e/flamespeed-0.1.2.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a43801edaa4264e4b02e40ae104790f5",
                    "sha256": "25621ab31c5cef92aa7898769669829fb364d16fe6c50e4cbb22448f1580f4e4"
                },
                "downloads": -1,
                "filename": "flamespeed-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "a43801edaa4264e4b02e40ae104790f5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 14242,
                "upload_time": "2017-11-19T19:23:51",
                "url": "https://files.pythonhosted.org/packages/89/92/7bef7113eb1e9cfb361b65c80bace9552bf2ecc8ba992d15a6254bed31e8/flamespeed-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4ec7354b06b55eed8f1bb260ebe4a722",
                    "sha256": "750da5ac2941d557255db12cefca8409ce068e279c15f09fbb67749da2e1857a"
                },
                "downloads": -1,
                "filename": "flamespeed-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "4ec7354b06b55eed8f1bb260ebe4a722",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 29522,
                "upload_time": "2017-12-09T18:13:13",
                "url": "https://files.pythonhosted.org/packages/fc/4b/396233740052703a7c8d8fa248d06b83e40319f46feab9aaf688b785a4c5/flamespeed-0.1.5.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "eee3cb465fd3356b5fe15b204e67cbb4",
                    "sha256": "096bc9261157bc40c373ec63da9e41278cba0c11f6dc8a7a95606dadea343014"
                },
                "downloads": -1,
                "filename": "flamespeed-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "eee3cb465fd3356b5fe15b204e67cbb4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 30280,
                "upload_time": "2017-12-10T01:52:23",
                "url": "https://files.pythonhosted.org/packages/00/b8/43f92b577f20c78ebe2105496381fc720b17d19d0c32843992fb1113a923/flamespeed-0.1.6.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b5f5b42db256c7578ee982bef48f1780",
                    "sha256": "ad991f976c61ef123c3b2b22bb7fe727fc82a4f251fe3f1932b37275e1514401"
                },
                "downloads": -1,
                "filename": "flamespeed-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b5f5b42db256c7578ee982bef48f1780",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 30301,
                "upload_time": "2017-12-11T22:14:06",
                "url": "https://files.pythonhosted.org/packages/03/7b/ac14cdbbd6fe484cc7a87fcf345fcbb8de1e91a2e5bbde8b3ab1bc50962b/flamespeed-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b5f5b42db256c7578ee982bef48f1780",
                "sha256": "ad991f976c61ef123c3b2b22bb7fe727fc82a4f251fe3f1932b37275e1514401"
            },
            "downloads": -1,
            "filename": "flamespeed-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b5f5b42db256c7578ee982bef48f1780",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 30301,
            "upload_time": "2017-12-11T22:14:06",
            "url": "https://files.pythonhosted.org/packages/03/7b/ac14cdbbd6fe484cc7a87fcf345fcbb8de1e91a2e5bbde8b3ab1bc50962b/flamespeed-1.0.1.tar.gz"
        }
    ]
}