fairyfly-therm
  • Site
      • CLI Docs
        • Installation
        • Commands
          • setconfig
            • fairyfly-therm set-config
              • lbnl-data-path
              • therm-lib-path
              • therm-path
      • fairyfly_therm package
        • Subpackages
          • fairyfly_therm.cli package
            • Submodules
              • fairyfly_therm.cli.setconfig module
            • Module contents
          • fairyfly_therm.condition package
            • Submodules
              • fairyfly_therm.condition.steadystate module
                • SteadyState
                  • ToString()
                  • duplicate()
                  • extract_all_from_xml_file()
                  • from_dict()
                  • from_therm_xml()
                  • from_therm_xml_str()
                  • lock()
                  • to_dict()
                  • to_therm_xml()
                  • to_therm_xml_str()
                  • unlock()
                  • color
                  • display_name
                  • emissivity
                  • film_coefficient
                  • heat_flux
                  • identifier
                  • project_tag
                  • protected
                  • radiant_temperature
                  • relative_humidity
                  • temperature
                  • user_data
            • Module contents
          • fairyfly_therm.lib package
            • Submodules
              • fairyfly_therm.lib.conditions module
                • condition_by_name()
              • fairyfly_therm.lib.gases module
                • gas_by_name()
                • pure_gas_by_name()
              • fairyfly_therm.lib.materials module
                • cavity_material_by_name()
                • solid_material_by_name()
            • Module contents
          • fairyfly_therm.material package
            • Submodules
              • fairyfly_therm.material.cavity module
                • CavityMaterial
                  • ToString()
                  • duplicate()
                  • from_dict()
                  • from_dict_abridged()
                  • from_therm_xml()
                  • from_therm_xml_str()
                  • lock()
                  • to_dict()
                  • to_therm_xml()
                  • to_therm_xml_str()
                  • unlock()
                  • CAVITY_MODELS
                  • cavity_model
                  • color
                  • display_name
                  • emissivity
                  • emissivity_back
                  • gas
                  • identifier
                  • protected
                  • therm_uuid
                  • user_data
              • fairyfly_therm.material.dictutil module
                • dict_abridged_to_material()
                • dict_to_material()
              • fairyfly_therm.material.gas module
                • Gas
                  • ToString()
                  • conductivity_at_temperature()
                  • density_at_temperature()
                  • duplicate()
                  • extract_all_from_xml_file()
                  • from_dict()
                  • from_dict_abridged()
                  • from_therm_xml()
                  • from_therm_xml_str()
                  • lock()
                  • prandtl_at_temperature()
                  • specific_heat_at_temperature()
                  • to_dict()
                  • to_therm_xml()
                  • to_therm_xml_str()
                  • unlock()
                  • viscosity_at_temperature()
                  • conductivity
                  • density
                  • display_name
                  • gas_count
                  • gas_fractions
                  • identifier
                  • molecular_weight
                  • prandtl
                  • protected
                  • pure_gases
                  • specific_heat
                  • user_data
                  • viscosity
                • PureGas
                  • ToString()
                  • conductivity_at_temperature()
                  • density_at_temperature()
                  • duplicate()
                  • from_dict()
                  • from_therm_xml()
                  • from_therm_xml_str()
                  • lock()
                  • prandtl_at_temperature()
                  • specific_heat_at_temperature()
                  • to_dict()
                  • to_therm_xml()
                  • to_therm_xml_str()
                  • unlock()
                  • viscosity_at_temperature()
                  • conductivity
                  • conductivity_coeff_a
                  • conductivity_coeff_b
                  • conductivity_coeff_c
                  • density
                  • display_name
                  • identifier
                  • molecular_weight
                  • prandtl
                  • protected
                  • specific_heat
                  • specific_heat_coeff_a
                  • specific_heat_coeff_b
                  • specific_heat_coeff_c
                  • specific_heat_ratio
                  • user_data
                  • viscosity
                  • viscosity_coeff_a
                  • viscosity_coeff_b
                  • viscosity_coeff_c
              • fairyfly_therm.material.solid module
                • SolidMaterial
                  • ToString()
                  • duplicate()
                  • from_dict()
                  • from_therm_xml()
                  • from_therm_xml_str()
                  • lock()
                  • to_dict()
                  • to_therm_xml()
                  • to_therm_xml_str()
                  • unlock()
                  • color
                  • conductivity
                  • density
                  • display_name
                  • emissivity
                  • emissivity_back
                  • identifier
                  • porosity
                  • protected
                  • resistivity
                  • specific_heat
                  • user_data
                  • vapor_diffusion_resistance
              • fairyfly_therm.material.xmlutil module
                • extract_all_materials_from_xml_file()
            • Module contents
          • fairyfly_therm.properties package
            • Submodules
              • fairyfly_therm.properties.boundary module
                • BoundaryThermProperties
                  • ToString()
                  • apply_properties_from_dict()
                  • duplicate()
                  • from_dict()
                  • is_equivalent()
                  • to_dict()
                  • condition
                  • host
              • fairyfly_therm.properties.model module
                • ModelThermProperties
                  • ToString()
                  • apply_properties_from_dict()
                  • check_all()
                  • check_all_duplicate_identifiers()
                  • check_duplicate_condition_identifiers()
                  • check_duplicate_gas_identifiers()
                  • check_duplicate_material_identifiers()
                  • check_for_extension()
                  • duplicate()
                  • load_properties_from_dict()
                  • to_dict()
                  • ERROR_MAP
                  • conditions
                  • gases
                  • host
                  • materials
              • fairyfly_therm.properties.shape module
                • ShapeThermProperties
                  • ToString()
                  • apply_properties_from_dict()
                  • duplicate()
                  • from_dict()
                  • is_equivalent()
                  • to_dict()
                  • host
                  • material
            • Module contents
        • Submodules
          • fairyfly_therm.config module
            • Folders
              • THERM_VERSION
              • bc_steady_state_lib_file
              • config_file
              • gas_lib_file
              • lbnl_data_path
              • material_lib_file
              • therm_exe
              • therm_lib_path
              • therm_path
              • therm_settings_path
              • therm_version
              • therm_version_str
          • fairyfly_therm.writer module
            • boundary_to_therm_xml()
            • boundary_to_therm_xml_str()
            • model_to_therm_xml()
            • model_to_therm_xml_str()
            • model_to_thmz()
            • shape_to_therm_xml()
            • shape_to_therm_xml_str()
        • Module contents
  • Page
      • CLI Docs
      • fairyfly_therm package
  • CLI Docs »
  • Source
  • CLI Docs
  • fairyfly_therm package

Welcome to fairyfly-therm’s documentation!¶

Fairyfly extension for import and export to/from THERM

Installation¶

pip install fairyfly-therm

fairyfly-therm¶

CLI Docs¶

For command line interface documentation and API documentation see the pages below.

  • CLI Docs
    • Installation
    • Commands

fairyfly_therm¶

  • fairyfly_therm package
    • Subpackages
      • fairyfly_therm.cli package
        • Submodules
        • Module contents
      • fairyfly_therm.condition package
        • Submodules
        • Module contents
      • fairyfly_therm.lib package
        • Submodules
        • Module contents
      • fairyfly_therm.material package
        • Submodules
        • Module contents
      • fairyfly_therm.properties package
        • Submodules
        • Module contents
    • Submodules
      • fairyfly_therm.config module
        • Folders
      • fairyfly_therm.writer module
        • boundary_to_therm_xml()
        • boundary_to_therm_xml_str()
        • model_to_therm_xml()
        • model_to_therm_xml_str()
        • model_to_thmz()
        • shape_to_therm_xml()
        • shape_to_therm_xml_str()
    • Module contents

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Back to top

© Copyright 2026, Ladybug Tools.
Created using Sphinx 8.0.2.