foxes 0.8.1__py3-none-any.whl → 1.0__py3-none-any.whl

docs/source/conf.py

@@ -0,0 +1,353 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+from foxes import __version__
+
+# -- Project information -----------------------------------------------------
+
+project = "foxes"
+copyright = "2024, Fraunhofer IWES"
+author = "Fraunhofer IWES"
+
+# The short X.Y version
+version = __version__
+# The full version, including alpha/beta/rc tags
+release = __version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "nbsphinx",
+    "sphinx_immaterial",
+    "sphinx_immaterial.apidoc.python.apigen",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    # "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.mathjax",
+    # "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    # "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.doctest",
+    "m2r2",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
+}
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ["_templates"]
+# autosummary_generate = False
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = [".rst", ".md"]
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    # ipynb checkpoints
+    "notebooks/.ipynb_checkpoints/*.ipynb",
+    "build/*",
+    # "_templates/*",
+    # DEBUG
+    # "examples.rst",
+    # "notebooks/*",
+    # "notebooks/layout_opt.ipynb",
+    # "notebooks/timelines.ipynb",
+    # "notebooks/heterogeneous.ipynb",
+    # "notebooks/timeseries.ipynb",
+    # "api.rst"
+]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+# autosummary_generate = True
+napolean_use_rtype = False
+
+# -- Options for sphinxcontrib.email ------------------------------------------
+# email_automode = True
+
+
+# -- Options for nbsphinx -----------------------------------------------------
+
+# Execute notebooks before conversion: 'always', 'never', 'auto' (default)
+# We execute all notebooks, exclude the slow ones using 'exclude_patterns'
+nbsphinx_execute = "always"
+
+# Use this kernel instead of the one stored in the notebook metadata:
+# nbsphinx_kernel_name = 'python3'
+
+# List of arguments to be passed to the kernel that executes the notebooks:
+# nbsphinx_execute_arguments = []
+
+# If True, the build process is continued even if an exception occurs:
+# nbsphinx_allow_errors = True
+
+
+# Controls when a cell will time out (defaults to 30; use -1 for no timeout):
+nbsphinx_timeout = 500
+
+# Default Pygments lexer for syntax highlighting in code cells:
+# nbsphinx_codecell_lexer = 'ipython3'
+
+# Width of input/output prompts used in CSS:
+# nbsphinx_prompt_width = '8ex'
+
+# If window is narrower than this, input/output prompts are on separate lines:
+# nbsphinx_responsive_width = '700px'
+
+# This is processed by Jinja2 and inserted before each notebook
+# Fix for issue with pyplot, cf
+# https://github.com/readthedocs/sphinx_rtd_theme/issues/788#issuecomment-585785027
+nbsphinx_prolog = r"""
+.. raw:: html
+
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/require.min.js'></script>
+    <script>require=requirejs;</script>
+
+
+"""
+
+# This is processed by Jinja2 and inserted after each notebook
+# nbsphinx_epilog = r"""
+# """
+
+# Input prompt for code cells. "%s" is replaced by the execution count.
+nbsphinx_input_prompt = "In [%s]:"
+
+# Output prompt for code cells. "%s" is replaced by the execution count.
+nbsphinx_output_prompt = "Out[%s]:"
+
+# Specify conversion functions for custom notebook formats:
+# import jupytext
+# nbsphinx_custom_formats = {
+#    '.Rmd': lambda s: jupytext.reads(s, '.Rmd'),
+# }
+
+# Link or path to require.js, set to empty string to disable
+# nbsphinx_requirejs_path = ''
+
+# Options for loading require.js
+# nbsphinx_requirejs_options = {'async': 'async'}
+mathjax3_config = {
+    "TeX": {"equationNumbers": {"autoNumber": "AMS", "useLabelIds": True}},
+}
+
+# Additional files needed for generating LaTeX/PDF output:
+# latex_additional_files = ['references.bib']
+
+# -- Options for autodoc ----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
+
+# Automatically extract typehints when specified and place them in
+# descriptions of the relevant function/method.
+autodoc_typehints = "description"
+
+# Don't show class signature with the class' name.
+autodoc_class_signature = "separated"
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_immaterial"
+
+# html_theme = 'cloud'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    # TOC options
+    #'navigation_depth': 2,  # only show 2 levels on left sidebar
+    # "collapse_navigation": False,  # don't allow sidebar to collapse,
+    "site_url": "https://fraunhoferiwes.github.io/foxes.docs/index.html",
+    "repo_url": "https://github.com/FraunhoferIWES/foxes",
+    "icon": {"repo": "fontawesome/brands/github", "edit": "material/file-edit-outline"},
+    "palette": {"primary": "teal"},
+    "toc_title_is_page_title": True,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ["_static"]
+
+# custom.css is inside one of the html_static_path folders (e.g. _static)
+# html_css_files = ["custom.css"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "foxesdoc"
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "foxes.tex", "foxes Documentation", "Fraunhofer IWES", "manual"),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "foxes", "foxes Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "foxes",
+        "foxes Documentation",
+        author,
+        "foxes",
+        "Farm Optimization and eXtended yield Evaluation Software",
+        "Miscellaneous",
+    ),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+
+# -- python_apigen configuration -------------------------------------------------
+
+python_apigen_modules = {
+    "foxes.variables": "_foxes/variables/",
+    "foxes.constants": "_foxes/constants/",
+    "foxes.algorithms": "_foxes/algorithms/",
+    "foxes.algorithms.downwind": "_foxes/algorithms/downwind/",
+    "foxes.algorithms.downwind.models": "_foxes/algorithms/downwind/models/",
+    "foxes.algorithms.iterative": "_foxes/algorithms/iterative/",
+    "foxes.algorithms.iterative.models": "_foxes/algorithms/iterative/models/",
+    "foxes.algorithms.sequential": "_foxes/algorithms/sequential/",
+    "foxes.algorithms.sequential.models": "_foxes/algorithms/sequential/models/",
+    "foxes.core": "_foxes/core/",
+    "foxes.data": "_foxes/data/",
+    "foxes.engines": "_foxes/engines/",
+    "foxes.input.farm_layout": "_foxes/input/farm_layout/",
+    "foxes.input.states": "_foxes/input/states/",
+    "foxes.input.states.create": "_foxes/input/states/create/",
+    "foxes.input.windio": "_foxes/input/windio/",
+    "foxes.output": "_foxes/output/",
+    "foxes.output.flow_plots_2d": "_foxes/output/flow_plots_2d/",
+    "foxes.output.seq_plugins": "_foxes/output/seq_plugins/",
+    "foxes.models": "_foxes/models/",
+    "foxes.models.farm_controllers": "_foxes/models/farm_controllers/",
+    "foxes.models.farm_models": "_foxes/models/farm_models/",
+    "foxes.models.partial_wakes": "_foxes/models/partial_wakes/",
+    "foxes.models.point_models": "_foxes/models/point_models/",
+    "foxes.models.rotor_models": "_foxes/models/rotor_models/",
+    "foxes.models.turbine_models": "_foxes/models/turbine_models/",
+    "foxes.models.turbine_types": "_foxes/models/turbine_types/",
+    "foxes.models.vertical_profiles": "_foxes/models/vertical_profiles/",
+    "foxes.models.axial_induction": "_foxes/models/axial_induction",
+    "foxes.models.ground_models": "_foxes/models/ground_models",
+    "foxes.models.wake_frames": "_foxes/models/wake_frames/",
+    "foxes.models.wake_models": "_foxes/models/wake_models/",
+    "foxes.models.wake_models.induction": "_foxes/models/wake_models/induction/",
+    "foxes.models.wake_models.wind": "_foxes/models/wake_models/wind/",
+    "foxes.models.wake_models.ti": "_foxes/models/wake_models/ti/",
+    "foxes.models.wake_superpositions": "_foxes/models/wake_superpositions/",
+    "foxes.utils": "_foxes/utils/",
+    "foxes.utils.abl": "_foxes/utils/abl",
+    "foxes.utils.geom2d": "_foxes/utils/geom2d/",
+    "foxes.utils.runners": "_foxes/utils/runners/",
+    "foxes.utils.two_circles": "_foxes/utils/two_circles/",
+    "foxes.utils.abl.neutral": "_foxes/utils/abl/neutral/",
+    "foxes.utils.abl.stable": "_foxes/utils/abl/stable/",
+    "foxes.utils.abl.unstable": "_foxes/utils/abl/unstable/",
+    "foxes.utils.abl.sheared": "_foxes/utils/abl/sheared/",
+}

examples/abl_states/run.py

@@ -0,0 +1,160 @@
+import time
+import argparse
+
+import foxes
+import foxes.variables as FV
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-l",
+        "--layout",
+        help="The wind farm layout file (path or static)",
+        default="test_farm_67.csv",
+    )
+    parser.add_argument(
+        "-s",
+        "--states",
+        help="The states input file (path or static)",
+        default="abl_states_6000.csv.gz",
+    )
+    parser.add_argument(
+        "-t",
+        "--turbine_file",
+        help="The P-ct-curve csv file (path or static)",
+        default="NREL-5MW-D126-H90.csv",
+    )
+    parser.add_argument("-r", "--rotor", help="The rotor model", default="level4")
+    parser.add_argument(
+        "-p", "--pwakes", help="The partial wakes models", default=None, nargs="+"
+    )
+    parser.add_argument(
+        "-w",
+        "--wakes",
+        help="The wake models",
+        default=["CrespoHernandez_quadratic_k002", "Bastankhah2016_linear_lim_k004"],
+        nargs="+",
+    )
+    parser.add_argument(
+        "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
+    )
+    parser.add_argument("-e", "--engine", help="The engine", default=None)
+    parser.add_argument(
+        "-n", "--n_cpus", help="The number of cpus", default=None, type=int
+    )
+    parser.add_argument(
+        "-c",
+        "--chunksize_states",
+        help="The chunk size for states",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-C",
+        "--chunksize_points",
+        help="The chunk size for points",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-nf", "--nofig", help="Do not show figures", action="store_true"
+    )
+    args = parser.parse_args()
+
+    mbook = foxes.models.ModelBook()
+    ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
+    mbook.turbine_types[ttype.name] = ttype
+
+    states = foxes.input.states.StatesTable(
+        data_source=args.states,
+        output_vars=[FV.WS, FV.WD, FV.TI, FV.RHO, FV.MOL],
+        var2col={FV.WS: "ws", FV.WD: "wd", FV.TI: "ti", FV.MOL: "mol"},
+        fixed_vars={FV.RHO: 1.225, FV.Z0: 0.05, FV.H: 100.0},
+        profiles={FV.WS: "ABLLogWsProfile"},
+    )
+
+    farm = foxes.WindFarm()
+    foxes.input.farm_layout.add_from_file(
+        farm,
+        args.layout,
+        col_x="x",
+        col_y="y",
+        col_H="H",
+        turbine_models=args.tmodels + [ttype.name],
+    )
+
+    algo = foxes.algorithms.Downwind(
+        farm,
+        states,
+        wake_models=args.wakes,
+        rotor_model=args.rotor,
+        wake_frame="rotor_wd",
+        partial_wakes=args.pwakes,
+        mbook=mbook,
+        engine=args.engine,
+        n_procs=args.n_cpus,
+        chunk_size_states=args.chunksize_states,
+        chunk_size_points=args.chunksize_points,
+    )
+
+    time0 = time.time()
+    farm_results = algo.calc_farm()
+    time1 = time.time()
+
+    print("\nCalc time =", time1 - time0, "\n")
+
+    print(farm_results)
+
+    fr = farm_results.to_dataframe()
+    print(fr[[FV.WD, FV.H, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P]])
+
+    o = foxes.output.FarmResultsEval(farm_results)
+    o = foxes.output.FarmResultsEval(farm_results)
+    o.add_capacity(algo)
+    o.add_capacity(algo, ambient=True)
+    o.add_efficiency()
+
+    # state-turbine results
+    farm_df = farm_results.to_dataframe()
+    print("\nFarm results data:\n")
+    print(
+        farm_df[
+            [
+                FV.X,
+                FV.WD,
+                FV.AMB_REWS,
+                FV.REWS,
+                FV.AMB_TI,
+                FV.TI,
+                FV.AMB_P,
+                FV.P,
+                FV.EFF,
+            ]
+        ]
+    )
+    print()
+
+    # results by turbine
+    turbine_results = o.reduce_states(
+        {
+            FV.AMB_P: "mean",
+            FV.P: "mean",
+            FV.AMB_CAP: "mean",
+            FV.CAP: "mean",
+            FV.EFF: "mean",
+        }
+    )
+    turbine_results[FV.AMB_YLD] = o.calc_turbine_yield(
+        algo=algo, annual=True, ambient=True
+    )
+    turbine_results[FV.YLD] = o.calc_turbine_yield(algo=algo, annual=True)
+    print("\nResults by turbine:\n")
+    print(turbine_results)
+
+    # power results
+    P0 = o.calc_mean_farm_power(ambient=True)
+    P = o.calc_mean_farm_power()
+    print(f"\nFarm power        : {P/1000:.1f} MW")
+    print(f"Farm ambient power: {P0/1000:.1f} MW")
+    print(f"Farm efficiency   : {o.calc_farm_efficiency():.2f}")
+    print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")