diff --git a/README.md b/README.md index c920a11e..9894cba8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # README # hercules -Hercules, based on the acronym "Hybrid Energy and Control Using Large Eddy Simulations", is an open-source tool for wind-based hybrid plant simulation in real time. Hercules is based around high fidelity wind farm flow simulations through AMR-Wind, co-simulated with a hybrid plant that includes solar, storage, and generation. The entire hybrid plant can be controlled using the [Wind Hybrid Open Controller (WHOC)](https://github.com/nrel/wind-hybrid-open-controller). +Hercules is an open-source tool for wind-based hybrid plant simulation in real time. Hercules is emulated a wind farm co-simulated other generation to form a hybrid plant that can include solar, storage and electrolyzers. The entire hybrid plant can be controlled using the [Wind Hybrid Open Controller (WHOC)](https://github.com/nrel/wind-hybrid-open-controller). # Documentation diff --git a/docs/intro.md b/docs/intro.md index cc96a284..e57c3157 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -1,5 +1,5 @@ # Hercules -Hybrid Energy and Control Using Large Eddy Simulations +Hercules is an open-source tool for wind-based hybrid plant simulation in real time. Hercules is emulated a wind farm co-simulated other generation to form a hybrid plant that can include solar, storage and electrolyzers. The entire hybrid plant can be controlled using the [Wind Hybrid Open Controller (WHOC)](https://github.com/nrel/wind-hybrid-open-controller). Online documentation for Hercules \ No newline at end of file diff --git a/example_case_folders/05_floris_standin_and_electrolyzer/hercules_runscript_CLcontrol.py b/example_case_folders/05_floris_standin_and_electrolyzer/hercules_runscript_CLcontrol.py index 7bc65a3e..98077aff 100644 --- a/example_case_folders/05_floris_standin_and_electrolyzer/hercules_runscript_CLcontrol.py +++ b/example_case_folders/05_floris_standin_and_electrolyzer/hercules_runscript_CLcontrol.py @@ -1,17 +1,3 @@ -# Copyright 2021 NREL - -# Licensed under the Apache License, Version 2.0 (the "License"); you may not -# use this file except in compliance with the License. You may obtain a copy of -# the License at http://www.apache.org/licenses/LICENSE-2.0 - -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. - -# See https://nrel.github.io/wind-hybrid-open-controller for documentation - import sys from hercules.emulator import Emulator diff --git a/example_case_folders/09_heterogeneous_wind/hercules_runscript_CLcontrol.py b/example_case_folders/09_heterogeneous_wind/hercules_runscript_CLcontrol.py index 1afac9f1..0fea7608 100644 --- a/example_case_folders/09_heterogeneous_wind/hercules_runscript_CLcontrol.py +++ b/example_case_folders/09_heterogeneous_wind/hercules_runscript_CLcontrol.py @@ -1,17 +1,3 @@ -# Copyright 2021 NREL - -# Licensed under the Apache License, Version 2.0 (the "License"); you may not -# use this file except in compliance with the License. You may obtain a copy of -# the License at http://www.apache.org/licenses/LICENSE-2.0 - -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. - -# See https://nrel.github.io/wind-hybrid-open-controller for documentation - import sys from hercules.emulator import Emulator diff --git a/hercules/amr_wind_standin.py b/hercules/amr_wind_standin.py index ac14c147..e2ae7a07 100644 --- a/hercules/amr_wind_standin.py +++ b/hercules/amr_wind_standin.py @@ -1,15 +1,3 @@ -# Copyright 2022 NREL - -# Licensed under the Apache License, Version 2.0 (the "License"); you may not -# use this file except in compliance with the License. You may obtain a copy of -# the License at http://www.apache.org/licenses/LICENSE-2.0 - -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. - # This script implements a test client to test out the server against # It is based on code from # https://github.com/TUDelft-DataDrivenControl/SOWFA/blob/master/exampleCases/example.12.piso.NREL5MW.ADM.zmqSSC.python/ssc/testclient.py diff --git a/hercules/floris_standin.py b/hercules/floris_standin.py index 1faff36f..ac9745bb 100644 --- a/hercules/floris_standin.py +++ b/hercules/floris_standin.py @@ -1,15 +1,3 @@ -# Copyright 2022 NREL - -# Licensed under the Apache License, Version 2.0 (the "License"); you may not -# use this file except in compliance with the License. You may obtain a copy of -# the License at http://www.apache.org/licenses/LICENSE-2.0 - -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. - # This script implements a test client to test out the server against # It is based on code from # https://github.com/TUDelft-DataDrivenControl/SOWFA/blob/master/exampleCases/example.12.piso.NREL5MW.ADM.zmqSSC.python/ssc/testclient.py diff --git a/pyproject.toml b/pyproject.toml index 409da14c..19cf887e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "hercules" version = "1.1" -description = "Python front-end to the emulator." +description = "Hybrid plant emulation tool." readme = "README.md" requires-python = ">=3.9" authors = [