Skip to main content

Prognostics Python Package (ProgPy)

CodeFactor GitHub License GitHub Releases Binder

The NASA Prognostic Package (ProgPy) is a python prognostics framework focused on building, using, and evaluating models and algorithms for prognostics (computation of remaining useful life) and health management of engineering systems, and provides a set of prognostics models for select components and prognostics algorithms developed within this framework, suitable for use in prognostics for these components. It also includes algorithms for state estimation and prediction, including uncertainty propagation.

ProgPy was the 2024 NASA Software of the Year!

ProgPy combines NASAs prog_models and prog_algs packages into a single python package, for simplicity and clarity.

Installation

pip3 install progpy

or

pip3 install progpy[datadriven]

to include dependencies for data driven models

Documentation

See documentation here

Repository Directory Structure

Here is the directory structure for the github repository

src/progpy/ - The prognostics python package
examples/ - Example Python scripts using progpy
tests/ - Tests for progpy
README.md - The readme (this file)
prog_model_template.py - Template for Prognostics Model
state_estimator_template.py - Template for State Estimators
predictor_template.py - Template for Predictor

Citing this repository

Use the following to cite this repository:

@misc{2024_nasa_progpy,
  | author    = {Christopher Teubert and Katelyn Jarvis Griffith and Matteo Corbetta and Chetan Kulkarni and Portia Banerjee and Matthew Daigle},
  | title     = {{ProgPy Python Prognostics Packages}},
  | month     = May,
  | year      = 2025,
  | version   = {1.8},
  | url       = {https://nasa.github.io/progpy}
  | }

The corresponding reference should look like this:

C. Teubert, K. Jarvis Griffith, M. Corbetta, C. Kulkarni, P. Banerjee, M. Daigle, ProgPy Python Prognostics Packages, v1.8, May 2025. URL https://github.com/nasa/progpy.

Contributing Organizations

ProgPy was created by a partnership of multiple organizations, working together to build a set of high-quality prognostic tools for the wider PHM Community. We would like to give a big thank you for the ProgPy community, especially the following contributing organizations:

Acknowledgements

The structure and algorithms of this package are strongly inspired by the MATLAB Prognostics Model Library, MATLAB Prognostics Algorithm Library, and the MATLAB Prognostics Metrics Library. We would like to recognize Matthew Daigle and the rest of the team that contributed to the Prognostics Models, Algorithms, and Metrics Libraries for the contributions their work on the MATLAB library made to the design of progpy.

Notices

Copyright © 2021 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.

Disclaimers

No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."

Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.

Metadata

Release files for progpy 1.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for progpy 1.9.0
File Size Uploaded Provenance
progpy-1.9.0.tar.gz 424.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for progpy 1.9.0
File Interpreter ABI Platform
progpy-1.9.0-py3-none-any.whl Python 3 none any Details

Total release size: 824.7 kB

Release files / progpy-1.9.0.tar.gz

Download URL progpy-1.9.0.tar.gz
Size 424.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a7bb0ad9519d0bc0cbe4bc169776387f66e1accc0dd662ead1dfb5a6e9b2a8b1
BLAKE2b-256 checksum
How to use checksums
0e32e7f58a0c3890dcbfe0b014fd3844b981b78404798e5b8e923fe3cb2097db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Release files / progpy-1.9.0-py3-none-any.whl

Download URL progpy-1.9.0-py3-none-any.whl
Size 400.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
39db98c47613f7968dc59109333a88c7837c033dd3a34992dca0fbb0016b4348
BLAKE2b-256 checksum
How to use checksums
6d340ed49f7da1078afbd860b8f4ea927e5bf00a57c9879d00a4511e0ce65623
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Security for progpy 1.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page