diff --git a/pymcr/__init__.py b/pymcr/__init__.py index e3efe64..97e859d 100644 --- a/pymcr/__init__.py +++ b/pymcr/__init__.py @@ -1,4 +1,15 @@ -""" pyMCR: Pythonic Multivariate Curve Resolution - Alternating Least Squares """ +""" +pyMCR: Pythonic Multivariate Curve Resolution - Alternating Regression + +pyMCR is a small package for performing multivariate curve resolution. Currently, +it implements a simple alternating regression scheme (MCR-AR). The most common +implementation is with ordinary least-squares regression, MCR-ALS. + +See Also +-------- +https://pages.nist.gov/pyMCR + +""" from . import mcr from . import constraints from . import metrics