Skip to main content

The NASA Prognostic Model Package is a python modeling framework focused on defining and building models for prognostics (computation of remaining useful life) of engineering systems, and provides a set of prognostics models for select components developed within this framework, suitable for use in prognostics applications for these components.

Project description

Prognostics Model Python Package

CodeFactor GitHub License GitHub Releases Binder

The NASA Prognostic Model Package is a Python framework focused on defining and building models for prognostics (computation of remaining useful life) of engineering systems, and provides a set of prognostics models for select components developed within this framework, suitable for use in prognostics applications for these components.

This is part of the wider Prognostics Python Packages (ProgPy) and is designed to be used with the Prognostics Algorithms Package.

Installation

pip3 install prog_models

Documentation

See documentation here

Repository Directory Structure

Here is the directory structure for the github repository

src/prog_models/ - The prognostics model python package
examples/ - Example Python scripts using prog_models
tests/ - Tests for prog_models
README.md - The readme (this file)
prog_model_template.py - Template for Prognostics Model
tutorial.ipynb - Tutorial (Juypter Notebook)

Citing this repository

Use the following to cite this repository:

@misc{2023_nasa_prog_models,
    author    = {Christopher Teubert and Matteo Corbetta and Chetan Kulkarni and Katelyn Jarvis and Matthew Daigle},
    title     = {Prognostics Models Python Package},
    month     = June,
    year      = 2023,
    version   = {1.5},
    url       = {https://github.com/nasa/prog\_models}
    }

The corresponding reference should look like this:

C. Teubert, C. Kulkarni, M. Corbetta, K. Jarvis, M. Daigle, Prognostics Model Python Package, v1.5, June 2023. URL https://github.com/nasa/prog_models.

Alternatively, if using both prog_models and prog_algs, you can cite the combined package as

C. Teubert, C. Kulkarni, M. Corbetta, K. Jarvis, M. Daigle, ProgPy Prognostics Python Packages, v1.5, June 2023. URL https://nasa.github.io/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. We would like to recognize Matthew Daigle and the rest of the team that contributed to the Prognostics Model Library for the contributions their work on the MATLAB library made to the design of prog_models.

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.

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

prog_models-1.5.2.tar.gz (168.7 kB view details)

Uploaded Source

Built Distribution

prog_models-1.5.2-py3-none-any.whl (152.4 kB view details)

Uploaded Python 3

File details

Details for the file prog_models-1.5.2.tar.gz.

File metadata

  • Download URL: prog_models-1.5.2.tar.gz
  • Upload date:
  • Size: 168.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for prog_models-1.5.2.tar.gz
Algorithm Hash digest
SHA256 7423e32c616dad6916d85058fd65dca74163cf24440c114c6d32fca6573d7cd5
MD5 4be85a162ec2efd0998a7290b24e4a01
BLAKE2b-256 088f91d148f8b79a7aea1be3ddb256af7e1b57d414b1aebabe81bed659ed28d1

See more details on using hashes here.

File details

Details for the file prog_models-1.5.2-py3-none-any.whl.

File metadata

  • Download URL: prog_models-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 152.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for prog_models-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 23be9a241beedbfcd619d15c3a30e2f74b7e11e0ff4dee21b58cb1aa7dad2fb6
MD5 e531ec36e3261c059877f4169d181659
BLAKE2b-256 faafba671886582d3f3b3c08ad95246a901c47684d6bb6a77ba4740fda86e905

See more details on using hashes here.

Supported by

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