/nusselt

Heat Transfer correlations library

Primary LanguagePythonMIT LicenseMIT

Nusselt

PyPI Status Python Version License

Read the documentation at https://nusselt.readthedocs.io/ Tests Codecov

pre-commit Black

Development Guide

First time setup

  1. Install the multiple Python versions for testing with asdf:
asdf install python 3.8.18 3.9.18 3.10.13 3.11.7 3.12.1
  1. Install pipx with Homebrew:
brew install pipx
pipx ensurepath
  1. Install required tools with:
pipx install poetry nox
pipx inject nox nox-poetry
  1. Clone this repository and run poetry install inside it.

Development Workflow

User Installation

You can install Nusselt via pip from PyPI:

$ pip install nusselt

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Nusselt is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.