mechanical-tolerance-calculator 0.1.0

A Python package for material tolerance calculations

Tolerances Package

A Python package for material tolerance calculations, converted from the original JavaScript npm package.

Installation

From PyPI (once published)

pip install tolerances-package

From source

git clone https://github.com/yourusername/tolerances-package.git
cd tolerances-package
pip install -e .

Usage

from tolerances import (
    get_all_tolerances_for,
    get_camco_standard_tolerances_for,
    check_one_measurement_for,
    check_multiple_measurements_for
)

# Get all tolerances for a material type
housing_tolerances = get_all_tolerances_for("housing")
shaft_tolerances = get_all_tolerances_for("shaft")
shell_tolerances = get_all_tolerances_for("shell")

# Get Camco standard tolerances
camco_housing = get_camco_standard_tolerances_for("housing")
camco_shaft = get_camco_standard_tolerances_for("shaft")

# Check a single measurement
result = check_one_measurement_for("shaft", 5.98)
print(result)
# Output includes:
# - measurement: the input measurement
# - nominal: calculated nominal diameter
# - specification: the specification used (e.g., "h9")
# - IT_grade: the IT grade used
# - computed_specification_bounds: upper and lower bounds
# - meets_specification: whether the measurement meets specs
# - meets_IT_tolerance: whether it meets IT tolerance

# Check multiple measurements
measurements = [5.97, 5.98, 5.99, 6.00]
result = check_multiple_measurements_for("shaft", measurements)
print(result)
# Output includes all the above plus:
# - meets_IT_Tolerance: whether measurements meet IT tolerance
# - meets_final_compliance: overall compliance status

API Reference

get_all_tolerances_for(material_type: str) -> dict

Returns all tolerances for the given material type.

Parameters:

• material_type (str): The type of material. Valid values: 'housing', 'shaft', 'shell'

Returns:

• dict: Object containing the relevant tolerances or an error message

Example:

tolerances = get_all_tolerances_for("housing")

get_camco_standard_tolerances_for(material_type: str) -> dict

Returns Camco Standard specification and tolerances for the given material type.

Parameters:

• material_type (str): The type of material. Valid values: 'housing', 'shaft', 'shell'

Returns:

• dict: Object containing the Camco standard tolerances or an error message

Example:

camco_specs = get_camco_standard_tolerances_for("shaft")

check_one_measurement_for(material_type: str, measurement: float) -> dict

Check a single measurement against Camco standard tolerances.

Parameters:

• material_type (str): The type of material. Valid values: 'housing', 'shaft', 'shell'
• measurement (float): The measured value to check

Returns:

• dict: Detailed analysis including specification bounds and compliance status

Example:

result = check_one_measurement_for("shaft", 5.98)
if result.get("meets_IT_tolerance"):
    print("Measurement passes!")

check_multiple_measurements_for(material_type: str, measurements: list) -> dict

Check multiple measurements against Camco standard tolerances.

Parameters:

• material_type (str): The type of material. Valid values: 'housing', 'shaft', 'shell'
• measurements (list): A list of measured values to check

Returns:

• dict: Comprehensive analysis of all measurements including IT tolerance compliance

Example:

measurements = [5.97, 5.98, 5.99, 6.00]
result = check_multiple_measurements_for("shaft", measurements)
if result.get("meets_final_compliance"):
    print("All measurements pass!")

Material Types

The package supports three material types:

1. Housing - Uses H8 specification (IT6 grade)
2. Shaft - Uses h9 specification (IT5 grade)
3. Shell - Uses H9 specification (IT6 grade)

Data Format

The package requires a Tolerances.json file with the following structure:

{
  "housingBores": {
    "H8": {
      "specification": [
        {
          "minimum_diameter": 0,
          "maximum_diameter": 3,
          "upper_deviation": "0.014",
          "lower_deviation": "0.000",
          "IT6": 0.006
        }
      ]
    }
  },
  "shafts": {
    "h9": {
      "specification": [...]
    }
  },
  "shellBores": {
    "H9": {
      "specification": [...]
    }
  }
}

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For issues and questions, please open an issue on GitHub.