Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 994 Bytes

README.md

File metadata and controls

31 lines (25 loc) · 994 Bytes

HemTracer

A Python package providing convenient CFD post-processing functions for Lagrangian hemolysis estimation.

Installation

The project has been tested on macOS for Python 3.12.0 with the packages listed in requirements.txt.

The recommended way to install is to create a virtual environment from the home folder of this repository

python3.12 -m venv env
source venv/bin/activate
python3 -m pip install .

This creates a folder env that will contain all required packages, ensuring consistent conditions. You can exit the virtual environment by running

deactivate

Usage

Whenever you want to use hemtracer, you need to activate the virtual environment first by running

source /path/to/hemtracer/venv/bin/activate

Then your Python will use the correct environment and you can run

python3 your_hemo_analysis_script.py

Code

Check the code documentation for more information.