Skip to content

Misc

pybeerxml.misc.Misc

Bases: BeerXmlModel

A miscellaneous ingredient — finings, spices, water agents, etc.

Attributes:

Name Type Description
name str | None

Ingredient name.

version int | None

BeerXML misc record version.

type str | None

Category — "Spice", "Fining", "Water Agent", "Herb", "Flavor", or "Other".

amount LenientFloat

Quantity — weight in kg or volume in litres depending on amount_is_weight.

amount_is_weight bool | None

True if amount is measured by weight (kg), False if by volume (L).

use str | None

When the ingredient is added — "Boil", "Mash", "Primary", "Secondary", or "Bottling".

use_for str | None

Description of the ingredient's purpose.

time LenientFloat

Contact time in minutes.

notes str | None

Free-text notes.

Style

pybeerxml.style.Style

Bases: BeerXmlModel

Beer style guidelines from a BeerXML <STYLE> element.

All _min / _max pairs define the acceptable range for that parameter within the style.

Attributes:

Name Type Description
name str | None

Style name (e.g. "American IPA").

category str | None

Style category (e.g. "India Pale Ale").

version int | None

BeerXML style record version.

category_number str | None

Style category identifier from the style guide.

style_letter str | None

Style subcategory letter or identifier.

style_guide str | None

Style guide name (e.g. "BJCP").

type str | None

Beverage family (e.g. "Ale", "Lager", "Mead").

og_min LenientFloat

Minimum original gravity.

og_max LenientFloat

Maximum original gravity.

fg_min LenientFloat

Minimum final gravity.

fg_max LenientFloat

Maximum final gravity.

ibu_min LenientFloat

Minimum bitterness in IBU.

ibu_max LenientFloat

Maximum bitterness in IBU.

color_min LenientFloat

Minimum colour in SRM.

color_max LenientFloat

Maximum colour in SRM.

abv_min LenientFloat

Minimum ABV percentage.

abv_max LenientFloat

Maximum ABV percentage.

carb_min LenientFloat

Minimum carbonation in volumes of CO₂.

carb_max LenientFloat

Maximum carbonation in volumes of CO₂.

notes str | None

Free-text style notes.

Water

pybeerxml.water.Water

Bases: BeerXmlModel

Water chemistry profile from a BeerXML <WATER> element.

All ion concentrations are in parts per million (ppm / mg/L).

Attributes:

Name Type Description
name str | None

Water profile name (e.g. "Burton on Trent").

amount LenientFloat

Volume of water in litres.

calcium LenientFloat

Calcium (Ca²⁺) concentration in ppm.

bicarbonate LenientFloat

Bicarbonate (HCO₃⁻) concentration in ppm.

sulfate LenientFloat

Sulfate (SO₄²⁻) concentration in ppm.

chloride LenientFloat

Chloride (Cl⁻) concentration in ppm.

sodium LenientFloat

Sodium (Na⁺) concentration in ppm.

magnesium LenientFloat

Magnesium (Mg²⁺) concentration in ppm.

ph LenientFloat

Water pH.

notes str | None

Free-text notes.

Equipment

pybeerxml.equipment.Equipment

Bases: BeerXmlModel

Brewing equipment profile from a BeerXML <EQUIPMENT> element.

Attributes:

Name Type Description
name str | None

Equipment set name.

boil_size LenientFloat

Pre-boil kettle volume in litres.

batch_size LenientFloat

Target post-boil batch volume in litres.

tun_volume LenientFloat

Mash tun capacity in litres.

tun_weight LenientFloat

Mash tun weight in kg (used for heat loss calculations).

tun_specific_heat LenientFloat

Specific heat of the tun material in Cal/(g·°C).

top_up_water LenientFloat

Water added to the fermenter to reach batch_size in litres.

trub_chiller_loss LenientFloat

Volume lost to trub and chiller deadspace in litres.

evap_rate LenientFloat

Evaporation rate in litres per hour.

boil_time LenientFloat

Boil duration in minutes.

calc_boil_volume bool | None

Whether the pre-boil volume should be calculated from equipment parameters.

lauter_deadspace LenientFloat

Volume lost in the lauter tun in litres.

top_up_kettle LenientFloat

Water added to the kettle before the boil in litres.

hop_utilization LenientFloat

Global hop utilization multiplier (%).

notes str | None

Free-text notes.