# Doxyfile for PyHelios Python Documentation

# Generated for PyHelios - Python bindings for Helios plant simulation software

#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

PROJECT_NAME = "PyHelios"

PROJECT_NUMBER = 0.0.4.post0

PROJECT_BRIEF =

PROJECT_LOGO = docs/images/PyHelios_logo_whiteborder.png

PROJECT_ICON = docs/images/Helios_icon.png

OUTPUT_DIRECTORY = docs/generated

CREATE_SUBDIRS = NO

ALLOW_UNICODE_NAMES = NO

OUTPUT_LANGUAGE = English

BRIEF_MEMBER_DESC = YES

REPEAT_BRIEF = YES

ABBREVIATE_BRIEF = "The $name class" \

"The $name widget" \

"The $name file" \

is \

provides \

specifies \

contains \

represents \

a \

an \

the

ALWAYS_DETAILED_SEC = NO

INLINE_INHERITED_MEMB = NO

FULL_PATH_NAMES = YES

STRIP_FROM_PATH =

STRIP_FROM_INC_PATH =

SHORT_NAMES = NO

JAVADOC_AUTOBRIEF = NO

JAVADOC_BANNER = NO

QT_AUTOBRIEF = NO

MULTILINE_CPP_IS_BRIEF = NO

PYTHON_DOCSTRING = YES

INHERIT_DOCS = YES

SEPARATE_MEMBER_PAGES = NO

TAB_SIZE = 4

ALIASES =

OPTIMIZE_OUTPUT_FOR_C = NO

OPTIMIZE_OUTPUT_JAVA = YES

OPTIMIZE_FOR_FORTRAN = NO

OPTIMIZE_OUTPUT_VHDL = NO

OPTIMIZE_OUTPUT_SLICE = NO

EXTENSION_MAPPING = py=Python

MARKDOWN_SUPPORT = YES

TOC_INCLUDE_HEADINGS = 5

AUTOLINK_SUPPORT = YES

BUILTIN_STL_SUPPORT = NO

CPP_CLI_SUPPORT = NO

SIP_SUPPORT = NO

IDL_PROPERTY_SUPPORT = YES

DISTRIBUTE_GROUP_DOC = NO

GROUP_NESTED_COMPOUNDS = NO

SUBGROUPING = YES

INLINE_GROUPED_CLASSES = NO

INLINE_SIMPLE_STRUCTS = NO

TYPEDEF_HIDES_STRUCT = NO

LOOKUP_CACHE_SIZE = 0

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

EXTRACT_ALL = YES

EXTRACT_PRIVATE = NO

EXTRACT_PRIV_VIRTUAL = NO

EXTRACT_PACKAGE = NO

EXTRACT_STATIC = YES

EXTRACT_LOCAL_CLASSES = YES

EXTRACT_LOCAL_METHODS = NO

EXTRACT_ANON_NSPACES = NO

HIDE_UNDOC_MEMBERS = NO

HIDE_UNDOC_CLASSES = NO

HIDE_FRIEND_COMPOUNDS = NO

HIDE_IN_BODY_DOCS = NO

INTERNAL_DOCS = NO

CASE_SENSE_NAMES = YES

HIDE_SCOPE_NAMES = NO

HIDE_COMPOUND_REFERENCE= NO

SHOW_INCLUDE_FILES = YES

SHOW_GROUPED_MEMB_INC = NO

FORCE_LOCAL_INCLUDES = NO

INLINE_INFO = YES

SORT_MEMBER_DOCS = YES

SORT_BRIEF_DOCS = NO

SORT_MEMBERS_CTORS_1ST = NO

SORT_GROUP_NAMES = NO

SORT_BY_SCOPE_NAME = NO

STRICT_PROTO_MATCHING = NO

GENERATE_TODOLIST = YES

GENERATE_TESTLIST = YES

GENERATE_BUGLIST = YES

GENERATE_DEPRECATEDLIST= YES

ENABLED_SECTIONS =

MAX_INITIALIZER_LINES = 30

SHOW_USED_FILES = YES

SHOW_FILES = YES

SHOW_NAMESPACES = YES

FILE_VERSION_FILTER =

LAYOUT_FILE = docs/DoxygenLayout.xml

CITE_BIB_FILES =

#---------------------------------------------------------------------------

# Configuration options related to warning and progress messages

#---------------------------------------------------------------------------

QUIET = NO

WARNINGS = YES

WARN_IF_UNDOCUMENTED = YES

WARN_IF_DOC_ERROR = YES

WARN_NO_PARAMDOC = NO

WARN_AS_ERROR = NO

WARN_FORMAT = "$file:$line: $text"

WARN_LOGFILE =

#---------------------------------------------------------------------------

# Configuration options related to the input files

#---------------------------------------------------------------------------

INPUT = pyhelios \

docs/introduction.md \

docs/user_guide.md \

docs/file_io.md \

docs/cross_platform.md \

docs/plugin_system.md \

docs/plugin_build_system.md \

docs/cuda_setup.md \

docs/docker_gpu.md \

docs/plugin_integration_guide.md \

docs/plugin_boundarylayerconductance.md \

docs/plugin_energybalance.md \

docs/plugin_leafoptics.md \

docs/plugin_lidar.md \

docs/plugin_parameteroptimization.md \

docs/plugin_photosynthesis.md \

docs/plugin_plantarchitecture.md \

docs/plugin_radiation.md \

docs/plugin_solarposition.md \

docs/plugin_stomatalconductance.md \

docs/plugin_visualizer.md \

docs/plugin_weberpenntree.md \

docs/Validation.md \

docs/CHANGELOG.md \

README.md

INPUT_ENCODING = UTF-8

INPUT_FILE_ENCODING =

FILE_PATTERNS = *.py \

*.md \

*.txt

RECURSIVE = YES

EXCLUDE = pyhelios/plugins/__pycache__ \

pyhelios/__pycache__ \

docs/plugin_integration_guide.md \

docs/cpp_plugin_integration_guide.md \

pyhelios/wrappers/UBoundaryLayerConductanceWrapper.py \

pyhelios/wrappers/UContextWrapper.py \

pyhelios/wrappers/UGlobalWrapper.py \

pyhelios/wrappers/ULoggerWrapper.py \

pyhelios/wrappers/UPlantArchitectureWrapper.py \

pyhelios/wrappers/URadiationModelWrapper.py \

pyhelios/wrappers/UEnergyBalanceWrapper.py \

pyhelios/wrappers/UPhotosynthesisWrapper.py \

pyhelios/wrappers/USolarPositionWrapper.py \

pyhelios/wrappers/UStomatalConductanceWrapper.py \

pyhelios/wrappers/UVisualizerWrapper.py \

pyhelios/wrappers/UWeberPennTreeWrapper.py \

pyhelios/config \

pyhelios/assets \

pyhelios/plugins/loader.py \

pyhelios/plugins/registry.py \

pyhelios/dev_utils.py \

pyhelios/_types.py \

pyhelios/_version.py \

tests \

build_scripts \

helios-core

EXCLUDE_SYMLINKS = NO

EXCLUDE_PATTERNS = */__pycache__/* \

*/.*

EXCLUDE_SYMBOLS = *::int *::float *::str *::bool *::list *::tuple *::dict

EXAMPLE_PATH = docs/examples

EXAMPLE_PATTERNS = *.py

EXAMPLE_RECURSIVE = YES

IMAGE_PATH = docs/images

INPUT_FILTER =

FILTER_PATTERNS = *.py="doxypypy --autobrief"

FILTER_SOURCE_FILES = NO

FILTER_SOURCE_PATTERNS =

USE_MDFILE_AS_MAINPAGE = README.md

#---------------------------------------------------------------------------

# Configuration options related to source browsing

#---------------------------------------------------------------------------

SOURCE_BROWSER = YES

INLINE_SOURCES = NO

STRIP_CODE_COMMENTS = YES

REFERENCED_BY_RELATION = NO

REFERENCES_RELATION = NO

REFERENCES_LINK_SOURCE = YES

SOURCE_TOOLTIPS = YES

USE_HTAGS = NO

VERBATIM_HEADERS = YES

#---------------------------------------------------------------------------

# Configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

ALPHABETICAL_INDEX = YES

IGNORE_PREFIX =

#---------------------------------------------------------------------------

# Configuration options related to the HTML output

#---------------------------------------------------------------------------

GENERATE_HTML = YES

HTML_OUTPUT = html

HTML_FILE_EXTENSION = .html

HTML_HEADER = docs/header.html

HTML_FOOTER =

HTML_STYLESHEET =

HTML_EXTRA_STYLESHEET = docs/assets/doxygen-awesome.css \

docs/assets/doxygen-awesome-sidebar-only.css \

docs/assets/doxygen-awesome-sidebar-only-darkmode-toggle.css \

docs/assets/pyhelios-custom.css

HTML_EXTRA_FILES = docs/assets/doxygen-awesome-darkmode-toggle.js \

docs/assets/doxygen-awesome-tabs.js \

docs/assets/doxygen-awesome-interactive-toc.js \

docs/assets/doxygen-awesome-paragraph-link.js \

docs/assets/doxygen-awesome-fragment-copy-button.js \

docs/images/PyHelios_logo_whiteborder.png \

docs/.nojekyll

HTML_COLORSTYLE_HUE = 220

HTML_COLORSTYLE_SAT = 100

HTML_COLORSTYLE_GAMMA = 80

HTML_DYNAMIC_MENUS = YES

HTML_DYNAMIC_SECTIONS = YES

HTML_INDEX_NUM_ENTRIES = 100

GENERATE_DOCSET = NO

DOCSET_FEEDNAME = "Doxygen generated docs"

DOCSET_BUNDLE_ID = org.doxygen.Project

DOCSET_PUBLISHER_ID = org.doxygen.Publisher

DOCSET_PUBLISHER_NAME = Publisher

GENERATE_HTMLHELP = NO

CHM_FILE =

HHC_LOCATION =

GENERATE_CHI = NO

CHM_INDEX_ENCODING =

BINARY_TOC = NO

TOC_EXPAND = NO

GENERATE_QHP = NO

QCH_FILE =

QHP_NAMESPACE = org.doxygen.Project

QHP_VIRTUAL_FOLDER = doc

QHP_CUST_FILTER_NAME =

QHP_CUST_FILTER_ATTRS =

QHP_SECT_FILTER_ATTRS =

QHG_LOCATION =

GENERATE_ECLIPSEHELP = NO

ECLIPSE_DOC_ID = org.doxygen.Project

DISABLE_INDEX = NO

GENERATE_TREEVIEW = YES

ENUM_VALUES_PER_LINE = 4

TREEVIEW_WIDTH = 250

EXT_LINKS_IN_WINDOW = NO

HTML_FORMULA_FORMAT = png

FORMULA_FONTSIZE = 10

FORMULA_MACROFILE =

USE_MATHJAX = YES

MATHJAX_VERSION = MathJax_3

MATHJAX_FORMAT = HTML-CSS

MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@3

MATHJAX_EXTENSIONS =

MATHJAX_CODEFILE =

SEARCHENGINE = YES

SERVER_BASED_SEARCH = NO

EXTERNAL_SEARCH = NO

SEARCHENGINE_URL =

SEARCHDATA_FILE = searchdata.xml

EXTERNAL_SEARCH_ID =

EXTRA_SEARCH_MAPPINGS =

#---------------------------------------------------------------------------

# Configuration options related to the LaTeX output

#---------------------------------------------------------------------------

GENERATE_LATEX = NO

#---------------------------------------------------------------------------

# Configuration options related to the RTF output

#---------------------------------------------------------------------------

GENERATE_RTF = NO

#---------------------------------------------------------------------------

# Configuration options related to the man page output

#---------------------------------------------------------------------------

GENERATE_MAN = NO

#---------------------------------------------------------------------------

# Configuration options related to the XML output

#---------------------------------------------------------------------------

GENERATE_XML = NO

#---------------------------------------------------------------------------

# Configuration options related to the DOCBOOK output

#---------------------------------------------------------------------------

GENERATE_DOCBOOK = NO

#---------------------------------------------------------------------------

# Configuration options for the AutoGen Definitions output

#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF = NO

#---------------------------------------------------------------------------

# Configuration options related to the Perl module output

#---------------------------------------------------------------------------

GENERATE_PERLMOD = NO

#---------------------------------------------------------------------------

# Configuration options related to the preprocessor

#---------------------------------------------------------------------------

ENABLE_PREPROCESSING = YES

MACRO_EXPANSION = NO

EXPAND_ONLY_PREDEF = NO

SEARCH_INCLUDES = YES

INCLUDE_PATH =

INCLUDE_FILE_PATTERNS =

PREDEFINED =

EXPAND_AS_DEFINED =

SKIP_FUNCTION_MACROS = YES

#---------------------------------------------------------------------------

# Configuration options related to external references

#---------------------------------------------------------------------------

TAGFILES =

GENERATE_TAGFILE =

ALLEXTERNALS = NO

EXTERNAL_GROUPS = YES

EXTERNAL_PAGES = YES

#---------------------------------------------------------------------------

# Configuration options related to the dot tool

#---------------------------------------------------------------------------

DIA_PATH =

HIDE_UNDOC_RELATIONS = YES

HAVE_DOT = YES

DOT_NUM_THREADS = 0

DOT_FONTPATH =

CLASS_GRAPH = YES

COLLABORATION_GRAPH = YES

GROUP_GRAPHS = YES

UML_LOOK = NO

UML_LIMIT_NUM_FIELDS = 10

TEMPLATE_RELATIONS = NO

INCLUDE_GRAPH = YES

INCLUDED_BY_GRAPH = YES

CALL_GRAPH = NO

CALLER_GRAPH = NO

GRAPHICAL_HIERARCHY = YES

DIRECTORY_GRAPH = YES

DOT_IMAGE_FORMAT = png

INTERACTIVE_SVG = NO

DOT_PATH =

DOTFILE_DIRS =

MSCFILE_DIRS =

DIAFILE_DIRS =

PLANTUML_JAR_PATH =

PLANTUML_CFG_FILE =

PLANTUML_INCLUDE_PATH =

DOT_GRAPH_MAX_NODES = 50

MAX_DOT_GRAPH_DEPTH = 0

DOT_MULTI_TARGETS = NO

GENERATE_LEGEND = YES

DOT_CLEANUP = YES