Metadata-Version: 2.4
Name: hycon
Version: 0.7.1
Summary: Hybrid power plant controller.
Author-email: "Michael (Misha) Sinner" <michael.sinner@nlr.gov>
License: BSD 3-Clause License
        
        Copyright (c) 2025 Alliance for Energy Innovation, LLC and Colorado School of Mines.
        
        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.
Project-URL: Homepage, https://github.com/NatLabRockies/hycon
Project-URL: Documentation, https://natlabrockies.github.io/hycon/intro.html
Keywords: hycon
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy~=2.0
Requires-Dist: pandas~=2.0
Requires-Dist: matplotlib~=3.0
Requires-Dist: floris~=4.3
Requires-Dist: zmq
Provides-Extra: docs
Requires-Dist: jupyter-book==1.0.4; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Provides-Extra: develop
Requires-Dist: pytest; extra == "develop"
Requires-Dist: pre-commit; extra == "develop"
Requires-Dist: ruff; extra == "develop"
Requires-Dist: isort; extra == "develop"
Dynamic: license-file

# Hycon

Hycon is a python-based tool for real-time hybrid power plant control.
Hycon will primarily be run in simulation, although we intend that it could be 
used for physical plants in future. 

Hycon provides plant-level (and hybrid plant-level) controls such as
wake steering control, spatial filtering/consensus, active power control, 
and coordinated control of hybrid power plant assets;
and creates an entry point for the development of more advanced controllers. 

Hycon will interface with various simulation testbeds and lower level 
controllers, including:
- [Hercules](https://github.com/NatLabRockies/hercules)
- [FAST.Farm](https://github.com/OpenFAST/openfast)
- [ROSCO](https://github.com/NatLabRockies/rosco)

Hycon controllers will also call on design tools such as
[FLORIS](https://github.com/NatLabRockies/floris).

## WETO software

Hycon is primarily developed with the support from the U.S. Department of Energy and
is part of the [WETO Software Stack](https://natlabrockies.github.io/WETOStack).
For more information and other integrated modeling software, see:

- [Portfolio Overview](https://natlabrockies.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://natlabrockies.github.io/WETOStack/_static/entry_guide/index.html)
- [Wind Farm Controls Workshop](https://www.youtube.com/watch?v=f-w6whxIBrA&list=PL6ksUtsZI1dwRXeWFCmJT6cEN1xijsHJz)

NLR's software record for Hycon is SWR-25-54.

## Documentation

Documentation for Hycon, including installation instructions, can be found
[here](https://natlabrockies.github.io/hycon/intro.html).
