{
    "info": {
        "author": "NREL National Wind Technology Center",
        "author_email": "rafael.mudafort@nrel.gov",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: Apache Software License",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy"
        ],
        "description": "\nFLORIS Wake Modeling Utility\n----------------------------\n\n**Further documentation is available at http://floris.readthedocs.io/.**\n\nFor technical questions regarding FLORIS usage please first search for or post\nyour questions to\n`stackoverflow <https://stackoverflow.com/questions/tagged/floris>`_ using\nthe **floris** tag. Alternatively, please contact\n`Jen King <mailto:jennifer.king@nrel.gov>`_,\n`Paul Fleming <mailto:paul.fleming@nrel.gov>`_,\n`Chris Bay <mailto:chris.bay@nrel.gov>`_, and\n`Rafael Mudafort <mailto:rafael.mudafort@nrel.gov>`_.\n\nBackground and Objectives\n=========================\nThis FLORIS framework is designed to provide a computationally inexpensive,\ncontrols-oriented modeling tool of the steady-state wake characteristics in\na wind farm. The wake models implemented in this version of FLORIS are:\n\n- Jensen model for velocity deficit\n- Jimenez model for wake deflection\n- Gauss model for wake deflection and velocity deficit\n- Multi zone model for wake deflection and velocity deficit\n- Curl  model for wake deflection and velocity deficit\n\nMore information on all of these models can be found in the\n`theory <https://floris.readthedocs.io/en/develop/source/theory.html>`_\nsection of the online documentation.\n\nA couple of publications with practical information on using floris as a\nmodeling and simulation tool for controls research are\n\n1. Annoni, J., Fleming, P., Scholbrock, A., Roadman, J., Dana, S., Adcock, C.,\n    Port\u00e9-Agel, F, Raach, S., Haizmann, F., and Schlipf, D.: `Analysis of\n    control-oriented wake modeling tools using lidar field results <https://www.wind-energ-sci.net/3/819/2018/>`__,\n    in: Wind Energy Science, vol. 3, pp. 819-831, Copernicus Publications,\n    2018.\n2. Bay, C.J., King, J., Fleming, P., Mudafort, R., and Mart\u00ednez-Tossas, L.A.:\n    `Unlocking the Full Potential of Wake Steering: Implementation and\n    Assessment of a Controls-Oriented Model <https://www.wind-energ-sci-discuss.net/wes-2019-19/>`__,\n    submitted to Wind Energy Science Discussions, Copernicus Publications,\n    2019.\n\nCitation\n========\n\nIf FLORIS played a role in your research, please cite it. This software can be\ncited as:\n\n   FLORIS. Version 1.0.0 (2019). Available at https://github.com/nrel/floris.\n\nFor LaTeX users:\n\n.. code-block:: latex\n\n    @misc{FLORIS_2019,\n    author = {NREL},\n    title = {{FLORIS. Version 1.0.0}},\n    year = {2019},\n    publisher = {GitHub},\n    journal = {GitHub repository},\n    url = {https://github.com/NREL/floris}\n    }\n\n.. _installation:\n\nInstallation\n============\nUsing ``pip``, FLORIS can be installed in two ways\n\n- local editable install\n\n- using a tagged release version from the ``pip`` repo\n\nFor consistency between all developers, it is recommended to use Python\nvirtual environments;\n`this link <https://realpython.com/blog/python/python-virtual-environments-a-primer/>`_\nprovides a great introduction. Using virtual environments in a Jupyter Notebook\nis described `here <https://help.pythonanywhere.com/pages/IPythonNotebookVirtualenvs/>`_.\n\nLocal Editable Installation\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\nThe local editable installation allows developers to maintain an importable\ninstance of FLORIS while continuing to extend it. The alternative is to\nconstantly update python paths within the package to match the local\nenvironment.\n\nBefore doing the local install, the source code repository must be cloned\ndirectly from GitHub:\n\n.. code-block:: bash\n\n    git clone https://github.com/nrel/floris\n\nThen, using the local editable installation is as simple as running the\nfollowing command from the parent directory of the\ncloned repository:\n\n.. code-block:: bash\n\n    pip install -e floris\n\nFinally, test the installation by starting a python terminal and importing\nFLORIS:\n\n.. code-block:: bash\n\n    import floris\n\npip Repo Installation\n~~~~~~~~~~~~~~~~~~~~~\nThe FLORIS version available through the pip repository is typically the latest\ntagged and released major version. This version represents the most recent\nstable, tested, and validated code.\n\nIn this case, there is no need to download the source code directly. FLORIS\nand its dependencies can be installed with:\n\n.. code-block:: bash\n\n    pip install floris\n\nDependencies\n============\nFLORIS has dependencies on various math, statistics, and plotting libraries in\naddition to other general purpose packages. For the simulation and tool\nmodules, the dependencies are listed in ``floris/requirements.txt``. The\ndocumentation has additional requirements listed in\n``floris/docs/requirements.txt``.\n\nThe requirements files can be used to install everything with:\n\n.. code-block:: bash\n\n    pip install -r requirements.txt\n\nLicense\n=======\n\nCopyright 2019 NREL\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/NREL/FLORIS",
        "keywords": "",
        "license": "Apache-2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "FLORIS",
        "package_url": "https://pypi.org/project/FLORIS/",
        "platform": "",
        "project_url": "https://pypi.org/project/FLORIS/",
        "project_urls": {
            "Homepage": "https://github.com/NREL/FLORIS"
        },
        "release_url": "https://pypi.org/project/FLORIS/1.0.0/",
        "requires_dist": [
            "matplotlib (>=3)",
            "numpy (==1.16.3)",
            "pytest (>=4)",
            "scipy (==1.1.0)",
            "h5pyd (==0.3.3)",
            "pandas (==0.24.2)",
            "pyproj (==2.1.3)",
            "seaborn (==0.9.0)",
            "sphinxcontrib-napoleon (==0.7) ; extra == 'docs'",
            "readthedocs-sphinx-ext (==0.5.15) ; extra == 'docs'",
            "Sphinx (==2.0) ; extra == 'docs'"
        ],
        "requires_python": ">=3.3.0",
        "summary": "A controls-oriented engineering wake model.",
        "version": "1.0.0"
    },
    "last_serial": 5951552,
    "releases": {
        "0.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1c9163cb6b818980d9be2a7ae35f74e4",
                    "sha256": "f26648ec55371fdb86211b45352c1b6debc23c8aab26aa3b1a97a6bc811a3b85"
                },
                "downloads": -1,
                "filename": "floris-0.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1c9163cb6b818980d9be2a7ae35f74e4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19546,
                "upload_time": "2018-01-15T23:20:38",
                "url": "https://files.pythonhosted.org/packages/65/1a/5d1c4f23204e2dfed6fdec20094fec5efaa2fdbf45825e44a2d4252ea819/floris-0.0.0.tar.gz"
            }
        ],
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "09208f37755bbd96c14bbb66c6ad562e",
                    "sha256": "b374d88b6285bcbfeac8d38991575547af4a393812177a0406c0e54c19bd3047"
                },
                "downloads": -1,
                "filename": "FLORIS-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "09208f37755bbd96c14bbb66c6ad562e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19519,
                "upload_time": "2018-01-15T23:22:49",
                "url": "https://files.pythonhosted.org/packages/6d/56/34bb1f64ad46643c13bf9e0e16e9afc1a94638519a6a3206292cedcdb690/FLORIS-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "59a5486e618790f22d7f2740ac659584",
                    "sha256": "8e60e1a820e546db87bccd26ed3d9805220d82fb540fd39f5d6c050b5a4af9ba"
                },
                "downloads": -1,
                "filename": "FLORIS-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "59a5486e618790f22d7f2740ac659584",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": "~=3.3",
                "size": 32926,
                "upload_time": "2018-01-25T23:57:36",
                "url": "https://files.pythonhosted.org/packages/bd/d3/d6eb8b44f51269b5eec08e2c907bbf952b737be1bef4923b5acfa2ff9219/FLORIS-0.1.1-py3-none-any.whl"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c127ffe5ae4a04136d84818c9521823e",
                    "sha256": "ba5a83502826697810c6edd60eef2697eec4dda9208709e5ab1c7bc6c4fcb0f2"
                },
                "downloads": -1,
                "filename": "FLORIS-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c127ffe5ae4a04136d84818c9521823e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": "~=3.3",
                "size": 39292,
                "upload_time": "2018-03-21T00:02:40",
                "url": "https://files.pythonhosted.org/packages/90/6f/8368f46d5eb00b84f0f671b073cd52ad33a3c8d23d04eff51f79fc64bb25/FLORIS-0.2.0-py3-none-any.whl"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ace84cfde89c29ca97e8f08712aea168",
                    "sha256": "b74887a4612a684e40c2a2b2c31a7cb359ad1fa1eabecf86ca2feca62a5fcd08"
                },
                "downloads": -1,
                "filename": "FLORIS-0.3.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ace84cfde89c29ca97e8f08712aea168",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": "~=3.3",
                "size": 38912,
                "upload_time": "2018-04-04T15:36:08",
                "url": "https://files.pythonhosted.org/packages/7b/f7/37bc9c99a0b658406b6ae7bdd85ee27ea283764e179bcb66fb9476bcb73e/FLORIS-0.3.1-py3-none-any.whl"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "01cfc19f14c739d78b814afb9b2d52d4",
                    "sha256": "bdb1a39ff805697348f62143f132fd0d985b0a5ccec99c4fefb57a3bc7cadfeb"
                },
                "downloads": -1,
                "filename": "FLORIS-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "01cfc19f14c739d78b814afb9b2d52d4",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.3.0",
                "size": 81924,
                "upload_time": "2019-05-07T20:39:35",
                "url": "https://files.pythonhosted.org/packages/b3/40/887140a69877c35a911ebf1b8c00ce3c4d020624534072abbb4dfc34e8e2/FLORIS-1.0.0-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "01cfc19f14c739d78b814afb9b2d52d4",
                "sha256": "bdb1a39ff805697348f62143f132fd0d985b0a5ccec99c4fefb57a3bc7cadfeb"
            },
            "downloads": -1,
            "filename": "FLORIS-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "01cfc19f14c739d78b814afb9b2d52d4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.3.0",
            "size": 81924,
            "upload_time": "2019-05-07T20:39:35",
            "url": "https://files.pythonhosted.org/packages/b3/40/887140a69877c35a911ebf1b8c00ce3c4d020624534072abbb4dfc34e8e2/FLORIS-1.0.0-py3-none-any.whl"
        }
    ]
}