API Documentation

• pycalphad package
  • Subpackages
    • pycalphad.codegen package
      • Submodules
      • pycalphad.codegen.phase_record_factory module
      • pycalphad.codegen.sympydiff_utils module
      • Module contents
    • pycalphad.core package
      • Submodules
      • pycalphad.core.cache module
      • pycalphad.core.calculate module
      • pycalphad.core.composition_set module
      • pycalphad.core.conditions module
      • pycalphad.core.constants module
      • pycalphad.core.constraints module
      • pycalphad.core.eqsolver module
      • pycalphad.core.equilibrium module
      • pycalphad.core.errors module
      • pycalphad.core.halton module
      • pycalphad.core.hyperplane module
      • pycalphad.core.light_dataset module
      • pycalphad.core.lower_convex_hull module
      • pycalphad.core.minimizer module
      • pycalphad.core.phase_rec module
      • pycalphad.core.polytope module
      • pycalphad.core.solver module
      • pycalphad.core.starting_point module
      • pycalphad.core.utils module
      • pycalphad.core.workspace module
      • Module contents
    • pycalphad.io package
      • Submodules
      • pycalphad.io.cs_dat module
      • pycalphad.io.database module
      • pycalphad.io.grammar module
      • pycalphad.io.tdb module
      • pycalphad.io.tdb_keywords module
      • Module contents
    • pycalphad.mapping package
      • Subpackages
      • Submodules
      • pycalphad.mapping.compat_api module
      • pycalphad.mapping.plotting module
      • pycalphad.mapping.primitives module
      • pycalphad.mapping.starting_points module
      • pycalphad.mapping.utils module
      • pycalphad.mapping.zpf_checks module
      • pycalphad.mapping.zpf_equilibrium module
      • Module contents
    • pycalphad.models package
      • Submodules
      • pycalphad.models.model_mqmqa module
      • Module contents
    • pycalphad.plot package
      • Subpackages
      • Submodules
      • pycalphad.plot.eqplot module
      • pycalphad.plot.ternary module
      • pycalphad.plot.triangular module
      • pycalphad.plot.utils module
      • Module contents
    • pycalphad.property_framework package
      • Submodules
      • pycalphad.property_framework.computed_property module
      • pycalphad.property_framework.metaproperties module
      • pycalphad.property_framework.types module
      • pycalphad.property_framework.tzero module
      • pycalphad.property_framework.units module
      • Module contents
  • Submodules
  • pycalphad.model module
    • Model
      • Model.constituents
      • Model.BMAG
      • Model.CPM
      • Model.CPM_MIX
      • Model.DOO
      • Model.G
      • Model.GM
      • Model.GM_MIX
      • Model.H
      • Model.HM
      • Model.HM_MIX
      • Model.NT
      • Model.SM
      • Model.SM_MIX
      • Model.TC
      • Model.ast
      • Model.atomic_ordering_energy()
      • Model.beta
      • Model.build_phase()
      • Model.contributions
      • Model.curie_temperature
      • Model.degree_of_ordering
      • Model.einstein_energy()
      • Model.endmember_reference_model
      • Model.energy
      • Model.enthalpy
      • Model.entropy
      • Model.excess_mixing_energy()
      • Model.extrapolate_temperature_bounds
      • Model.formulaenergy
      • Model.formulaenthalpy
      • Model.get_internal_constraints()
      • Model.gradient
      • Model.heat_capacity
      • Model.ideal_mixing_energy()
      • Model.kohler_toop_excess_sum()
      • Model.magnetic_energy()
      • Model.mixing_energy
      • Model.mixing_enthalpy
      • Model.mixing_entropy
      • Model.mixing_heat_capacity
      • Model.moles()
      • Model.neel_temperature
      • Model.redlich_kister_sum()
      • Model.reference_energy()
      • Model.shift_reference_state()
      • Model.symbol_replace()
      • Model.twostate_energy()
      • Model.unwrap_piecewise()
      • Model.variables
      • Model.volume_energy()
      • Model.xiong_magnetic_energy()
    • ReferenceState
      • ReferenceState.fixed_statevars
      • ReferenceState.phase_name
      • ReferenceState.species
    • TestModel
    • classproperty
  • pycalphad.variables module
    • ChemicalPotential
      • ChemicalPotential.compute_property()
      • ChemicalPotential.display_name
      • ChemicalPotential.display_units
      • ChemicalPotential.expand_wildcard()
      • ChemicalPotential.implementation_units
      • ChemicalPotential.jansson_deltas()
      • ChemicalPotential.jansson_derivative()
    • Component
      • Component.name
      • Component.constituents
      • Component.cast_from()
      • Component.escaped_name
      • Component.number_of_atoms
    • IndependentPotential
    • MU
    • MassFraction
      • MassFraction.compute_property()
      • MassFraction.display_units
      • MassFraction.expand_wildcard()
      • MassFraction.implementation_units
    • MoleFraction
      • MoleFraction.compute_per_phase_property()
      • MoleFraction.compute_property()
      • MoleFraction.compute_property_gradient()
      • MoleFraction.display_units
      • MoleFraction.expand_wildcard()
      • MoleFraction.implementation_units
      • MoleFraction.jansson_deltas()
      • MoleFraction.jansson_derivative()
    • NP
    • PhaseFraction
      • PhaseFraction.compute_property()
      • PhaseFraction.display_units
      • PhaseFraction.expand_wildcard()
      • PhaseFraction.implementation_units
      • PhaseFraction.jansson_derivative()
    • PressureType
      • PressureType.display_name
      • PressureType.display_units
      • PressureType.implementation_units
    • SiteFraction
      • SiteFraction.compute_property()
      • SiteFraction.display_units
      • SiteFraction.expand_wildcard()
      • SiteFraction.implementation_units
    • Species
      • Species.name
      • Species.constituents
      • Species.charge
      • Species.cast_from()
      • Species.escaped_name
      • Species.number_of_atoms
      • Species.weight
    • StateVariable
      • StateVariable.compute_property()
      • StateVariable.display_name
      • StateVariable.display_units
      • StateVariable.filtered()
      • StateVariable.implementation_units
      • StateVariable.is_global_property
      • StateVariable.jansson_deltas()
      • StateVariable.jansson_derivative()
      • StateVariable.multiplicity
      • StateVariable.phase_name_without_suffix
      • StateVariable.shape
    • SystemMolesType
      • SystemMolesType.display_name
      • SystemMolesType.display_units
      • SystemMolesType.implementation_units
    • TemperatureType
      • TemperatureType.display_name
      • TemperatureType.display_units
      • TemperatureType.implementation_units
    • W
    • X
    • Y
    • get_mass_fractions()
    • get_mole_fractions()
    • site_fraction
    • unpack_components()
  • Module contents