Skip to main content
Ctrl+K
SunPeek Documentation - Home SunPeek Documentation - Home
  • Quick Start
  • User Guide
  • API Reference
  • Contribution Guide
  • GitHub
  • Quick Start
  • User Guide
  • API Reference
  • Contribution Guide
  • GitHub

Section Navigation

  • Python API Reference
    • sunpeek.common
      • sunpeek.common.common_units
        • sunpeek.common.common_units.Dimensionality
      • sunpeek.common.config_parser
        • sunpeek.common.config_parser.make_and_store_plant
        • sunpeek.common.config_parser.make_full_plant
      • sunpeek.common.errors
        • sunpeek.common.errors.AlgorithmError
        • sunpeek.common.errors.CalculationError
        • sunpeek.common.errors.CollectorDefinitionError
        • sunpeek.common.errors.ConfigurationError
        • sunpeek.common.errors.DataProcessingError
        • sunpeek.common.errors.DatabaseAlreadyExistsError
        • sunpeek.common.errors.DuplicateNameError
        • sunpeek.common.errors.IncompatibleUnitError
        • sunpeek.common.errors.NoDataError
        • sunpeek.common.errors.PCMethodError
        • sunpeek.common.errors.SensorDataNotFoundError
        • sunpeek.common.errors.SensorNotFoundError
        • sunpeek.common.errors.SunPeekError
        • sunpeek.common.errors.TimeIndexError
        • sunpeek.common.errors.TimeZoneError
        • sunpeek.common.errors.VirtualSensorConfigurationError
      • sunpeek.common.plot_utils
        • sunpeek.common.plot_utils.add_table
        • sunpeek.common.plot_utils.annotation_bbox
        • sunpeek.common.plot_utils.anonymize
        • sunpeek.common.plot_utils.box_title
        • sunpeek.common.plot_utils.create_pdf
        • sunpeek.common.plot_utils.dict_to_box
        • sunpeek.common.plot_utils.filename_from_string
        • sunpeek.common.plot_utils.get_filename
        • sunpeek.common.plot_utils.get_rectangle_below
        • sunpeek.common.plot_utils.get_xy_below
        • sunpeek.common.plot_utils.points_to_data
        • sunpeek.common.plot_utils.points_to_figfraction
        • sunpeek.common.plot_utils.prepare_figure
        • sunpeek.common.plot_utils.set_footer
        • sunpeek.common.plot_utils.set_page_number
        • sunpeek.common.plot_utils.update_rcparams
        • sunpeek.common.plot_utils.utc_str
        • sunpeek.common.plot_utils.Colors
        • sunpeek.common.plot_utils.Defaults
        • sunpeek.common.plot_utils.PlotResult
        • sunpeek.common.plot_utils.PlotSettings
        • sunpeek.common.plot_utils.PlotTarget
        • sunpeek.common.plot_utils.TableColumnFormat
      • sunpeek.common.time_zone
        • sunpeek.common.time_zone.get_data_timezone
        • sunpeek.common.time_zone.get_timezone_offset_minutes
        • sunpeek.common.time_zone.get_timezone_string
        • sunpeek.common.time_zone.process_timezone
        • sunpeek.common.time_zone.validate_timezone
      • sunpeek.common.unit_uncertainty
        • sunpeek.common.unit_uncertainty.assert_compatible
        • sunpeek.common.unit_uncertainty.check_quantity
        • sunpeek.common.unit_uncertainty.parse_quantity
        • sunpeek.common.unit_uncertainty.to_dict
        • sunpeek.common.unit_uncertainty.to_numpy
        • sunpeek.common.unit_uncertainty.to_pint
        • sunpeek.common.unit_uncertainty.to_s
      • sunpeek.common.utils
        • sunpeek.common.utils.create_db_engine
        • sunpeek.common.utils.get_db_conection_string
        • sunpeek.common.utils.get_env
        • sunpeek.common.utils.handle_api_exceptions
        • sunpeek.common.utils.json_to_df
        • sunpeek.common.utils.to_unix_str
        • sunpeek.common.utils.to_utc
        • sunpeek.common.utils.utc_str
        • sunpeek.common.utils.DatetimeTemplates
        • sunpeek.common.utils.LogConfig
        • sunpeek.common.utils.VerifyValidateMode
        • sunpeek.common.utils.MissingEnvVar
    • sunpeek.components
      • sunpeek.components.base
        • sunpeek.components.base.Component
        • sunpeek.components.base.SensorSlot
      • sunpeek.components.components_factories
        • sunpeek.components.components_factories.CollectorQDT
        • sunpeek.components.components_factories.CollectorSST
      • sunpeek.components.fluids
        • sunpeek.components.fluids.CoolPropFluid
        • sunpeek.components.fluids.CoolPropFluidDefinition
        • sunpeek.components.fluids.Fluid
        • sunpeek.components.fluids.FluidDefinition
        • sunpeek.components.fluids.FluidFactory
        • sunpeek.components.fluids.UninitialisedFluid
        • sunpeek.components.fluids.WPDFluid
        • sunpeek.components.fluids.WPDFluidDefinition
        • sunpeek.components.fluids.WPDFluidMixed
        • sunpeek.components.fluids.WPDFluidPure
      • sunpeek.components.fluids_wpd_models
        • sunpeek.components.fluids_wpd_models.ModelFactory
        • sunpeek.components.fluids_wpd_models.WPDModel
        • sunpeek.components.fluids_wpd_models.WPDModelMixed
        • sunpeek.components.fluids_wpd_models.WPDModelPure
      • sunpeek.components.helpers
        • sunpeek.components.helpers.make_tables
        • sunpeek.components.helpers.AccuracyClass
        • sunpeek.components.helpers.AlgoCheckMode
        • sunpeek.components.helpers.AttrSetterMixin
        • sunpeek.components.helpers.ComponentParam
        • sunpeek.components.helpers.DataUploadDefaults
        • sunpeek.components.helpers.InstallCondition
        • sunpeek.components.helpers.IsVirtual
        • sunpeek.components.helpers.PCSettingsDefaults
        • sunpeek.components.helpers.ResultStatus
        • sunpeek.components.helpers.SensorMap
        • sunpeek.components.helpers.UploadHistory
      • sunpeek.components.iam_methods
        • sunpeek.components.iam_methods.get_iam_ASHRAE
        • sunpeek.components.iam_methods.get_iam_ambrosetti
        • sunpeek.components.iam_methods.get_iam_interpolated
        • sunpeek.components.iam_methods.get_iam_k50
        • sunpeek.components.iam_methods.IAM_ASHRAE
        • sunpeek.components.iam_methods.IAM_Ambrosetti
        • sunpeek.components.iam_methods.IAM_Interpolated
        • sunpeek.components.iam_methods.IAM_K50
        • sunpeek.components.iam_methods.IAM_Method
      • sunpeek.components.jobs
        • sunpeek.components.jobs.Job
      • sunpeek.components.operational_events
        • sunpeek.components.operational_events.OperationalEvent
      • sunpeek.components.outputs_pc_method
        • sunpeek.components.outputs_pc_method.PCMethodOutput
        • sunpeek.components.outputs_pc_method.PCMethodOutputArray
        • sunpeek.components.outputs_pc_method.PCMethodOutputData
        • sunpeek.components.outputs_pc_method.PCMethodOutputPlant
      • sunpeek.components.physical
        • sunpeek.components.physical.convert_to_concrete_components
        • sunpeek.components.physical.Array
        • sunpeek.components.physical.Plant
      • sunpeek.components.sensor
        • sunpeek.components.sensor.Sensor
        • sunpeek.components.sensor.SensorInfo
      • sunpeek.components.sensor_types
      • sunpeek.components.types
        • sunpeek.components.types.calculate_eta0b
        • sunpeek.components.types.calculate_eta0hem
        • sunpeek.components.types.calculate_kd_Hess_and_Hanby
        • sunpeek.components.types.ApertureParameters
        • sunpeek.components.types.Collector
        • sunpeek.components.types.CollectorReferenceAreaTypes
        • sunpeek.components.types.CollectorTestTypes
        • sunpeek.components.types.CollectorTypes
        • sunpeek.components.types.SensorType
        • sunpeek.components.types.UninitialisedCollector
    • sunpeek.core_methods
      • sunpeek.core_methods.common
        • sunpeek.core_methods.common.main
        • sunpeek.core_methods.common.shading
      • sunpeek.core_methods.pc_method
        • sunpeek.core_methods.pc_method.OutputUnits
        • sunpeek.core_methods.pc_method.PCAccuracyClasses
        • sunpeek.core_methods.pc_method.PCFormulae
        • sunpeek.core_methods.pc_method.PCMethods
        • sunpeek.core_methods.pc_method.formula
        • sunpeek.core_methods.pc_method.main
        • sunpeek.core_methods.pc_method.plotting
        • sunpeek.core_methods.pc_method.wrapper
      • sunpeek.core_methods.virtuals
        • sunpeek.core_methods.virtuals.calculations
        • sunpeek.core_methods.virtuals.main
        • sunpeek.core_methods.virtuals.radiation
        • sunpeek.core_methods.virtuals.virtuals_array
        • sunpeek.core_methods.virtuals.virtuals_plant
    • sunpeek.db_utils
      • sunpeek.db_utils.crud
        • sunpeek.db_utils.crud.create_component
        • sunpeek.db_utils.crud.delete_component
        • sunpeek.db_utils.crud.get_components
        • sunpeek.db_utils.crud.get_operational_events
        • sunpeek.db_utils.crud.get_plants
        • sunpeek.db_utils.crud.get_sensors
        • sunpeek.db_utils.crud.update_component
      • sunpeek.db_utils.db_data_operations
      • sunpeek.db_utils.init_db
        • sunpeek.db_utils.init_db.apply_db_migrations
        • sunpeek.db_utils.init_db.init_db
        • sunpeek.db_utils.init_db.set_sqlite_pragma
    • sunpeek.exporter
      • sunpeek.exporter.create_export_config
      • sunpeek.exporter.create_export_package
      • sunpeek.exporter.dump_debug_info
  • Python Web API Reference
  • API Reference
  • sunpeek.core_methods
  • sunpeek.core...

sunpeek.core_methods.common#

Modules

main

shading

previous

sunpeek.core_methods

next

sunpeek.core_methods.common.main

Show Source

© Copyright 2020-2022, HarvestIT Consortium; 2023, SunPeek Open Source Contributors.

Created using Sphinx 8.0.2.

Built with the PyData Sphinx Theme 0.15.4.