Skip to main content

A Python package for working with CLIF EHR data

Project description

clifpy - Python Client for CLIF

CLIF Logo

Transform critical care data into actionable insights

PyPI version Python Versions License Documentation uv

Documentation | Quick Start | CLIF Website

Standardized framework for critical care data analysis and research

CLIFpy is the official Python implementation for working with CLIF (Common Longitudinal ICU data Format) data. Transform heterogeneous ICU data into standardized, analysis-ready datasets with built-in validation, clinical calculations, and powerful data manipulation tools.

Key Features

  • 📊 Comprehensive CLIF Support: Full implementation of all CLIF 2.0 tables with automatic schema validation
  • 🏥 Clinical Calculations: Built-in SOFA scores, comorbidity indices, and other ICU-specific metrics
  • 💊 Smart Unit Conversion: Automatically standardize medication dosages across different unit systems
  • 🔗 Encounter Stitching: Link related ICU stays within configurable time windows
  • High Performance: Leverages DuckDB and Polars for efficient processing of large datasets
  • 🌍 Timezone Aware: Proper timestamp handling across different healthcare systems
  • 📈 Wide Format Support: Transform longitudinal data into hourly resolution for analysis

Installation

pip install clifpy

Quick Example

from clifpy import ClifOrchestrator

# Load and validate CLIF data
orchestrator = ClifOrchestrator(
    data_directory='/path/to/clif/data',
    timezone='US/Eastern'
)

# Validate all tables against CLIF schemas
orchestrator.validate_all()

# Access individual tables
vitals = orchestrator.vitals.df
labs = orchestrator.labs.df

# Advanced features
wide_df = orchestrator.create_wide_dataset()  # Hourly resolution data
sofa_scores = orchestrator.compute_sofa_scores()  # Calculate SOFA scores

Development

CLIFpy uses uv for fast, reliable dependency management.

Quick Setup

  1. Install uv:

    curl -LsSf https://astral.sh/uv/install.sh | sh
    
  2. Clone and install:

    git clone https://github.com/Common-Longitudinal-ICU-data-Format/CLIFpy.git
    cd CLIFpy
    uv sync
    
  3. Run tests:

    uv run pytest
    

Feature Contributors

Feature Coder Clinician Status
SOFA Score Computation Kaveri Chhikara Will Parker Published
Respiratory Support Waterfall Kaveri Chhikara Nick Ingraham Published
Presumed Infection and ASE Vaishvik Chaudhari Kevin Buell Published
Cumulative Dose Calculation Zewei (Whiskey) Liao Future Feature
Lab Conversion Units Dema Therese Cathy Gao In Progress
CRRT Waterfall Kaveri Chhikara Shan Guleria, Jay Koyner Future Feature
Medication Unit Conversion Zewei (Whiskey) Liao Published

Links & Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clifpy-0.4.9.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clifpy-0.4.9-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file clifpy-0.4.9.tar.gz.

File metadata

  • Download URL: clifpy-0.4.9.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for clifpy-0.4.9.tar.gz
Algorithm Hash digest
SHA256 daad3c45f61c911ca17d1b5611fcda5e1327219851fd83bc6914ced76dc13ad3
MD5 6eb00691b0560287cc3f39e40693824b
BLAKE2b-256 f43ada891d0ae27a3ba10362c1fed4b632353561ceec769bfd68848c60d856c0

See more details on using hashes here.

File details

Details for the file clifpy-0.4.9-py3-none-any.whl.

File metadata

  • Download URL: clifpy-0.4.9-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for clifpy-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 144dbbb58a077aa638c9d4e83ac1ce58bc1d0eac91b84eaf13a9beaf4377a49f
MD5 6c2e0efac8c1e23284fa6b0db34a582f
BLAKE2b-256 ebbed106499bd6d845a344f628a3c1c3217fc4c5ecbfb7e9968135ed39375496

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page