Contributing

Contributions are welcome! Whether you want to add new equipment cost correlations, fix a bug, improve documentation, or add a new feature, please follow the guidelines below.

Getting started

  1. Fork the repository on GitHub.

  2. Clone your fork locally:

    git clone https://github.com/<your-username>/OpenPyTEA.git
cd OpenPyTEA

  3. Install the package in editable mode with dev dependencies:

    pip install -e ".[test]"
# or with uv:
uv sync

  4. Create a feature branch:

    git checkout -b feat/my-new-feature

  5. Make your changes, add tests, and open a pull request against main.

Adding equipment cost correlations

The cost database lives in src/openpytea/data/cost_correlations.csv. Each row defines one correlation:

Column

Description

key

Unique identifier (e.g., "compressor_centrifugal")

category

Display category (e.g., "Compressors (Centrifugal)")

type

Sub-type (e.g., "Centrifugal")

form

Correlation form: "power" or "quad_log"

s_lower

Minimum valid size parameter

s_upper

Maximum size parameter for a single unit

upper_parallel

Maximum total size (triggers parallelization above s_upper)

a, b, n

Power-law coefficients (\(C = a + b \cdot S^n\))

k1, k2, k3

Quad log-log coefficients (\(\log C = k_1 + k_2\log S + k_3(\log S)^2\))

cost_year

Reference year for the correlation (used for CEPCI adjustment)

Please cite the source of any new correlation in the PR description.

Running tests

pytest tests/

Adding docstrings

OpenPyTEA uses NumPy-style docstrings. New public functions and classes must include a docstring with at minimum a summary line, Parameters, Returns, and at least one Examples block.

def my_function(x: float, y: int = 10) -> float:
    """
    Brief one-line summary.

    Extended description (optional).

    Parameters
    ----------
    x : float
        Description of x.
    y : int, optional
        Description of y. Default is 10.

    Returns
    -------
    float
        Description of return value.

    Examples
    --------
    >>> my_function(3.5)
    35.0
    """

Code style

  • Formatting: black (line length 60 for src/, 88 elsewhere)

  • Linting: ruff — run ruff check src/ before committing

  • Type hints are encouraged for all public APIs

Reporting bugs

Please open an issue on GitHub Issues with:

  • A minimal reproducible example

  • The OpenPyTEA version (import openpytea; print(openpytea.__version__))

  • Your Python version and OS

For citation and license information, see Citation & License.