healthsciencecalculator
Submodules
Classes
Functions
|
Calculate Body Mass Index (BMI) and return detailed classification information. |
|
Computes Basal Metabolic Rate (BMR) using the Harris-Benedict equation. |
|
Calculate the Total Daily Energy Expenditure (TDEE) based on BMR and activity level. |
|
Converts values from one unit to another. |
Package Contents
- healthsciencecalculator.get_bmi(weight: float, height: float) BMIResult[source]
Calculate Body Mass Index (BMI) and return detailed classification information.
BMI is calculated as weight (kg) divided by height (m) squared.
- Parameters:
weight (float) – Weight in kilograms
height (float) – Height in meters
- Returns:
A dataclass containing: - bmi (float): The calculated BMI value - category (str): BMI category, one of:
’underweight’ (BMI < 18.5)
’healthy’ (BMI 18.5-24.9)
’overweight’ (BMI 25-29.9)
’class 1 obesity’ (BMI 30-34.9)
’class 2 obesity’ (BMI 35-39.9)
’class 3 obesity’ (BMI >= 40)
risk_level (str): Associated health risk level
- Return type:
- Raises:
ValueError – If weight or height is not positive
TypeError – If weight or height is not a number
- healthsciencecalculator.get_bmr(weight: float, height: float, age: int, sex: str) float[source]
Computes Basal Metabolic Rate (BMR) using the Harris-Benedict equation.
The BMR is an estimate of the number of calories your body needs to perform basic life-sustaining functions, such as breathing, circulation, and cell production.
- Parameters:
weight (float) – Weight of the individual in kilograms.
height (float) – Height of the individual in centimeters.
age (int) – Age of the individual in years.
sex (str) – Biological sex of the individual. Accepted values are “male” or “female”.
- Returns:
The estimated BMR value in calories per day.
- Return type:
float
Notes
The Harris-Benedict equation is used to calculate BMR: - For males: BMR = 88.362 + (13.397 * weight) + (4.799 * height) - (5.677 * age) - For females: BMR = 447.593 + (9.247 * weight) + (3.098 * height) - (4.330 * age)
Examples
>>> get_bmr(70, 175, 25, "male") 1668.872 >>> get_bmr(60, 165, 30, "female") 1392.247
- healthsciencecalculator.get_tdee(bmr: float, activity_level: str) float[source]
Calculate the Total Daily Energy Expenditure (TDEE) based on BMR and activity level.
- Parameters:
bmr (float) – The Basal Metabolic Rate (must be positive).
activity_level (str) – The activity level (allowed values: ‘sedentary’, ‘lightly active’, ‘moderately active’, ‘very active’, ‘extra active’).
- Returns:
The calculated TDEE (kcal/day).
- Return type:
float
- Raises:
ValueError – If bmr <= 0 or activity_level is not recognized.
Notes
- Sample multipliers (you may choose different ones if needed):
sedentary: 1.2
lightly active: 1.375
moderately active: 1.55
very active: 1.725
extra active: 1.9
- healthsciencecalculator.unit_convert(value: float, input_unit: str, output_unit: str)[source]
Converts values from one unit to another.
Supported measurement units: - Weight: kg, g, lb, stone - Length: m, cm, feet, inch - Temperature: C, F - Concentration: mg/dL, mmol/L - Volume: L, mL
- Parameters:
value (float) – The numeric value to be converted.
input_unit (str) – The unit of input value.
output_unit (str) – The desired unit of output value.
- Returns:
The output value in desired unit.
- Return type:
float
Examples
>>> unit_convert(1, "m", "cm") 100