flasc


Nameflasc JSON
Version 2.0.1 PyPI version JSON
download
home_pagehttps://github.com/NREL/flasc
SummaryFLASC provides a rich suite of analysis tools for SCADA data filtering & analysis, wind farm model validation, field experiment design, and field experiment monitoring.
upload_time2024-08-13 19:48:00
maintainerNone
docs_urlNone
authorNREL National Wind Technology Center
requires_pythonNone
licenseNone
keywords flasc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # FLORIS-Based Analysis for SCADA Data (FLASC)


**Note:** Further documentation is available at **https://nrel.github.io/flasc/**

## Description

FLASC provides a **rich suite of analysis tools** for SCADA data filtering, analysis,
wind farm model validation, field experiment design, and field experiment monitoring.

The repository is centrally built around NRELs in-house ``FLORIS`` wind farm model, available at
**https://github.com/nrel/floris**. FLASC also largely relies on the ``energy ratio``, among others,
to quantify wake losses in synthetic and historical data, to perform turbine northing calibrations,
and model parameter estimation.

For technical questions or concerns, please email paul.fleming@nrel.gov.


[![pages-build-deployment](https://github.com/NREL/flasc/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/NREL/flasc/actions/workflows/pages/pages-build-deployment)

[![Automated tests & code coverage](https://github.com/NREL/flasc/actions/workflows/continuous-integration-workflow.yaml/badge.svg)](https://github.com/NREL/flasc/actions/workflows/continuous-integration-workflow.yaml)

[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

## Installation

We recommend installing this repository in a separate virtual environment.
After creating a new virtual environment, clone this repository to your local
system and install it locally using ``pip``. The command for this is ``pip install -e flasc``.

If installing for develop, follow the developer [install instructions](https://nrel.github.io/flasc/installation.html)

## Documentation

Documentation is provided via the included examples folders as well as [online documentation](https://nrel.github.io/flasc/).

## Engaging on GitHub

FLASC leverages the following GitHub features to coordinate support and development efforts:

- [Discussions](https://github.com/NREL/flasc/discussions): Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions
- [Issues](https://github.com/NREL/flasc/issues): Report potential bugs and well-developed feature requests
- [Projects](https://github.com/orgs/NREL/projects/39): Include current and future work on a timeline and assign a person to "own" it

Your feedback is crucial in this environment, as it helps identify areas for enhancement, resolve issues, and ensure the project meets the needs of its users. By sharing your insights and suggestions, you contribute to the project's evolution and success.

Generally, the first entry point for the community will be within one of the
categories in Discussions.
[Ideas](https://github.com/NREL/flasc/discussions/categories/ideas) is a great spot to develop the
details for a feature request. [Q&A](https://github.com/NREL/flasc/discussions/categories/q-a)
is where to get usage support.
[Show and tell](https://github.com/NREL/flasc/discussions/categories/show-and-tell) is a free-form
space to show off the things you are doing with FLORIS.

# License

BSD 3-Clause License

Copyright (c) 2024, Alliance for Sustainable Energy LLC, All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions
and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials provided
with the distribution.

* Neither the name of the copyright holder nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NREL/flasc",
    "name": "flasc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "flasc",
    "author": "NREL National Wind Technology Center",
    "author_email": "paul.fleming@nrel.gov",
    "download_url": "https://files.pythonhosted.org/packages/b7/88/4388565b2d232a216f14f77d4a297f6c63431325b99e6d4af065346e0a40/flasc-2.0.1.tar.gz",
    "platform": null,
    "description": "# FLORIS-Based Analysis for SCADA Data (FLASC)\n\n\n**Note:** Further documentation is available at **https://nrel.github.io/flasc/**\n\n## Description\n\nFLASC provides a **rich suite of analysis tools** for SCADA data filtering, analysis,\nwind farm model validation, field experiment design, and field experiment monitoring.\n\nThe repository is centrally built around NRELs in-house ``FLORIS`` wind farm model, available at\n**https://github.com/nrel/floris**. FLASC also largely relies on the ``energy ratio``, among others,\nto quantify wake losses in synthetic and historical data, to perform turbine northing calibrations,\nand model parameter estimation.\n\nFor technical questions or concerns, please email paul.fleming@nrel.gov.\n\n\n[![pages-build-deployment](https://github.com/NREL/flasc/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/NREL/flasc/actions/workflows/pages/pages-build-deployment)\n\n[![Automated tests & code coverage](https://github.com/NREL/flasc/actions/workflows/continuous-integration-workflow.yaml/badge.svg)](https://github.com/NREL/flasc/actions/workflows/continuous-integration-workflow.yaml)\n\n[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n\n## Installation\n\nWe recommend installing this repository in a separate virtual environment.\nAfter creating a new virtual environment, clone this repository to your local\nsystem and install it locally using ``pip``. The command for this is ``pip install -e flasc``.\n\nIf installing for develop, follow the developer [install instructions](https://nrel.github.io/flasc/installation.html)\n\n## Documentation\n\nDocumentation is provided via the included examples folders as well as [online documentation](https://nrel.github.io/flasc/).\n\n## Engaging on GitHub\n\nFLASC leverages the following GitHub features to coordinate support and development efforts:\n\n- [Discussions](https://github.com/NREL/flasc/discussions): Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions\n- [Issues](https://github.com/NREL/flasc/issues): Report potential bugs and well-developed feature requests\n- [Projects](https://github.com/orgs/NREL/projects/39): Include current and future work on a timeline and assign a person to \"own\" it\n\nYour feedback is crucial in this environment, as it helps identify areas for enhancement, resolve issues, and ensure the project meets the needs of its users. By sharing your insights and suggestions, you contribute to the project's evolution and success.\n\nGenerally, the first entry point for the community will be within one of the\ncategories in Discussions.\n[Ideas](https://github.com/NREL/flasc/discussions/categories/ideas) is a great spot to develop the\ndetails for a feature request. [Q&A](https://github.com/NREL/flasc/discussions/categories/q-a)\nis where to get usage support.\n[Show and tell](https://github.com/NREL/flasc/discussions/categories/show-and-tell) is a free-form\nspace to show off the things you are doing with FLORIS.\n\n# License\n\nBSD 3-Clause License\n\nCopyright (c) 2024, Alliance for Sustainable Energy LLC, All rights reserved.\n\nRedistribution and use in source and binary forms, with or without modification, are permitted\nprovided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this list of conditions\nand the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice, this list of\nconditions and the following disclaimer in the documentation and/or other materials provided\nwith the distribution.\n\n* Neither the name of the copyright holder nor the names of its contributors may be used to\nendorse or promote products derived from this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR\nIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER\nOR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\nCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\nANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE\nOR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\nPOSSIBILITY OF SUCH DAMAGE.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "FLASC provides a rich suite of analysis tools for SCADA data filtering & analysis,  wind farm model validation, field experiment design, and field experiment monitoring.",
    "version": "2.0.1",
    "project_urls": {
        "Homepage": "https://github.com/NREL/flasc"
    },
    "split_keywords": [
        "flasc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1c7a8d0534495b1e95639980c5ba31d71d7085943310bf047108b95b66b5660c",
                "md5": "a0d038f421e54d36e43494bf496d1600",
                "sha256": "8ac72bca66424bd190f9770035de7a782ed4e6e7e37a97798aa13997909b9dc9"
            },
            "downloads": -1,
            "filename": "flasc-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a0d038f421e54d36e43494bf496d1600",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 115649,
            "upload_time": "2024-08-13T19:47:58",
            "upload_time_iso_8601": "2024-08-13T19:47:58.675522Z",
            "url": "https://files.pythonhosted.org/packages/1c/7a/8d0534495b1e95639980c5ba31d71d7085943310bf047108b95b66b5660c/flasc-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b7884388565b2d232a216f14f77d4a297f6c63431325b99e6d4af065346e0a40",
                "md5": "de1fab3cb23cb99f6a34729f288bd361",
                "sha256": "a7668c1628a6d90d8ddae9b9ac29f11695571cfd408f67384ad4b4c3e2e5def4"
            },
            "downloads": -1,
            "filename": "flasc-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "de1fab3cb23cb99f6a34729f288bd361",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 104079,
            "upload_time": "2024-08-13T19:48:00",
            "upload_time_iso_8601": "2024-08-13T19:48:00.104669Z",
            "url": "https://files.pythonhosted.org/packages/b7/88/4388565b2d232a216f14f77d4a297f6c63431325b99e6d4af065346e0a40/flasc-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-13 19:48:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NREL",
    "github_project": "flasc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "flasc"
}
        
Elapsed time: 0.62999s