Skip to content

Misc

pybeerxml.misc.Misc

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

Attributes:

Name Type Description
name str | None

Ingredient name.

type str | None

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

amount float | None

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

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 float | None

Contact time in minutes.

notes str | None

Free-text notes.

amount_is_weight property writable

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

Style

pybeerxml.style.Style dataclass

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").

og_min float | None

Minimum original gravity.

og_max float | None

Maximum original gravity.

fg_min float | None

Minimum final gravity.

fg_max float | None

Maximum final gravity.

ibu_min float | None

Minimum bitterness in IBU.

ibu_max float | None

Maximum bitterness in IBU.

color_min float | None

Minimum colour in SRM.

color_max float | None

Maximum colour in SRM.

abv_min float | None

Minimum ABV percentage.

abv_max float | None

Maximum ABV percentage.

carb_min float | None

Minimum carbonation in volumes of CO₂.

carb_max float | None

Maximum carbonation in volumes of CO₂.

notes str | None

Free-text style notes.

Water

pybeerxml.water.Water dataclass

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 float | None

Volume of water in litres.

calcium float | None

Calcium (Ca²⁺) concentration in ppm.

bicarbonate float | None

Bicarbonate (HCO₃⁻) concentration in ppm.

sulfate float | None

Sulfate (SO₄²⁻) concentration in ppm.

chloride float | None

Chloride (Cl⁻) concentration in ppm.

sodium float | None

Sodium (Na⁺) concentration in ppm.

magnesium float | None

Magnesium (Mg²⁺) concentration in ppm.

ph float | None

Water pH.

notes str | None

Free-text notes.

Equipment

pybeerxml.equipment.Equipment dataclass

Brewing equipment profile from a BeerXML <EQUIPMENT> element.

Attributes:

Name Type Description
name str | None

Equipment set name.

boil_size float | None

Pre-boil kettle volume in litres.

batch_size float | None

Target post-boil batch volume in litres.

tun_volume float | None

Mash tun capacity in litres.

tun_weight float | None

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

tun_specific_heat float | None

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

top_up_water float | None

Water added to the fermenter to reach batch_size in litres.

trub_chiller_loss float | None

Volume lost to trub and chiller deadspace in litres.

evap_rate float | None

Evaporation rate in litres per hour.

boil_time float | None

Boil duration in minutes.

lauter_deadspace float | None

Volume lost in the lauter tun in litres.

top_up_kettle float | None

Water added to the kettle before the boil in litres.

hop_utilization float | None

Global hop utilization multiplier (%).

notes str | None

Free-text notes.

calc_boil_volume property writable

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