DaSPi 2.3.3__tar.gz → 2.4.0__tar.gz

{daspi-2.3.3 → daspi-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: DaSPi
-Version: 2.3.3
+Version: 2.4.0
 Summary: Visualize and analyze your data with DaSPi. This package is designed for users who want to find relevant influencing factors in processes and validate improvements.
 Author-Email: Reto Jäggli <reto@jaeggli.email>
 License: MIT

daspi-2.4.0/daspi/__init__.py

@@ -0,0 +1,488 @@
+"""
+DaSPi — Process Analytics & Six Sigma in Python
+
+DaSPi helps engineers analyze and improve processes using statistical workflows.
+
+## Four Flagship Workflows
+
+1. **Gage R&R Analysis** — Verify measurement system capability (MSA Type 1 & 2)
+2. **Process Capability Analysis** — Evaluate if process meets specifications (Cp, Cpk)
+3. **Root Cause Analysis** — Identify factors that drive variation (ANOVA, regression)
+4. **Statistical Process Control** — Monitor process stability (SPC charts)
+
+Each workflow produces visual output + interpretation in under 20 lines of code.
+
+For detailed examples and documentation, visit: https://j4ggr.github.io/DaSPi/
+"""
+
+import importlib
+from typing import TYPE_CHECKING, Any
+
+from ._version import __version__
+from .config import CONFIG
+from .strings import STR
+
+if TYPE_CHECKING:
+    # These imports are never executed at runtime (TYPE_CHECKING is always
+    # False). They exist solely so static checkers (Pylance/Pyright, mypy)
+    # and IDE autocomplete can see these names as real module attributes,
+    # matching the entries in `__all__`. Actual runtime resolution still
+    # goes through `__getattr__` below, keeping `import daspi` cheap.
+    from .anova.convert import frames_to_html, get_term_name
+    from .anova.model import (
+        GageRnRModel,
+        GageStudyModel,
+        GeneralizedLinearModel,
+        LinearModel,
+        hierarchical,
+        is_main_parameter,
+    )
+    from .anova.tables import (
+        anova_table,
+        terms_effect,
+        terms_probability,
+        uniques,
+        variance_inflation_factor,
+    )
+    from .constants import (
+        ANOVA,
+        CATEGORY,
+        COLOR,
+        DEFAULT,
+        DIST,
+        KW,
+        LABEL,
+        LINE,
+        PLOTTER,
+        RE,
+        SIGMA_DIFFERENCE,
+    )
+    from .datasets import list_dataset, load_dataset
+    from .doe import (
+        Factor,
+        FractionalFactorialDesignBuilder,
+        FullFactorial2kDesignBuilder,
+        FullFactorialDesignBuilder,
+        get_default_generators,
+    )
+    from .plotlib import style
+    from .plotlib.chart import Chart, JointChart, MultivariateChart, SingleChart
+    from .plotlib.classify import Dodger, HueLabel, ShapeLabel, SizeLabel
+    from .plotlib.facets import AxesFacets, LabelFacets, StripesFacets, flat_unique
+    from .plotlib.plotter import (
+        Bar,
+        Beeswarm,
+        BlandAltman,
+        Box,
+        CapabilityConfidenceInterval,
+        CategoricalObservation,
+        CenterLocation,
+        ConfidenceInterval,
+        DensityCurve,
+        ErrorBar,
+        FittedDensity,
+        GaussianKDE,
+        GaussianKDEContour,
+        GaussianKDEContourUnivariate,
+        HideSubplot,
+        Jitter,
+        Line,
+        LinearRegressionLine,
+        LoessLine,
+        MeanTest,
+        ParallelCoordinate,
+        Pareto,
+        Plotter,
+        Probability,
+        ProportionTest,
+        QuantileBoxes,
+        Scatter,
+        SkipSubplot,
+        SpreadWidth,
+        StandardErrorMean,
+        Stem,
+        StripeLine,
+        StripeSpan,
+        TransformPlotter,
+        VariationTest,
+        Violin,
+    )
+    from .plotlib.precast import (
+        BivariateUnivariateCharts,
+        GageRnRCharts,
+        GageStudyCharts,
+        PairComparisonCharts,
+        PairwiseMatrixCharts,
+        ParameterRelevanceCharts,
+        ProcessCapabilityAnalysisCharts,
+        ResidualsCharts,
+    )
+    from .statistics.confidence import (
+        bonferroni_ci,
+        confidence_to_alpha,
+        cp_ci,
+        cpk_ci,
+        delta_mean_ci,
+        delta_proportions_ci,
+        delta_stdev_ci,
+        delta_variance_ci,
+        fit_ci,
+        mean_ci,
+        median_ci,
+        prediction_ci,
+        proportion_ci,
+        sem,
+        stdev_ci,
+        variance_ci,
+    )
+    from .statistics.estimation import (
+        DistributionEstimator,
+        GageEstimator,
+        LocationDispersionEstimator,
+        Loess,
+        Lowess,
+        MeasurementUncertainty,
+        ProcessEstimator,
+        estimate_capability_confidence,
+        estimate_distribution,
+        estimate_kernel_density,
+        estimate_kernel_density_2d,
+        estimate_probability_density,
+        estimate_resolution,
+        root_sum_squares,
+    )
+    from .statistics.hypothesis import (
+        all_normal,
+        anderson_darling_test,
+        dunn_test,
+        f_test,
+        kolmogorov_smirnov_test,
+        kurtosis_test,
+        levene_test,
+        mean_stability_test,
+        pairwise_tests,
+        position_test,
+        proportions_test,
+        skew_test,
+        t_test,
+        variance_stability_test,
+        variance_test,
+    )
+    from .statistics.montecarlo import (
+        UNBOUNDED,
+        Binning,
+        RandomProcessValue,
+        Specification,
+        SpecLimits,
+        inclination_displacement,
+        round_to_nearest,
+    )
+
+# Everything below is loaded lazily (PEP 562 module __getattr__) the first
+# time it's accessed, e.g. `dsp.LinearModel`. This keeps `import daspi as dsp`
+# cheap: heavy third-party dependencies (scipy, matplotlib, pandas,
+# statsmodels, patsy) are only imported once a symbol that actually needs
+# them is used, instead of unconditionally at `import daspi` time.
+_LAZY_SUBMODULES: dict[str, str] = {
+    'frames_to_html': '.anova.convert',
+    'get_term_name': '.anova.convert',
+    'GageRnRModel': '.anova.model',
+    'GageStudyModel': '.anova.model',
+    'GeneralizedLinearModel': '.anova.model',
+    'LinearModel': '.anova.model',
+    'hierarchical': '.anova.model',
+    'is_main_parameter': '.anova.model',
+    'anova_table': '.anova.tables',
+    'terms_effect': '.anova.tables',
+    'terms_probability': '.anova.tables',
+    'uniques': '.anova.tables',
+    'variance_inflation_factor': '.anova.tables',
+    'ANOVA': '.constants',
+    'CATEGORY': '.constants',
+    'COLOR': '.constants',
+    'DEFAULT': '.constants',
+    'DIST': '.constants',
+    'KW': '.constants',
+    'LABEL': '.constants',
+    'LINE': '.constants',
+    'PLOTTER': '.constants',
+    'RE': '.constants',
+    'SIGMA_DIFFERENCE': '.constants',
+    'list_dataset': '.datasets',
+    'load_dataset': '.datasets',
+    'Factor': '.doe',
+    'FractionalFactorialDesignBuilder': '.doe',
+    'FullFactorial2kDesignBuilder': '.doe',
+    'FullFactorialDesignBuilder': '.doe',
+    'get_default_generators': '.doe',
+    'style': '.plotlib',
+    'Chart': '.plotlib.chart',
+    'JointChart': '.plotlib.chart',
+    'MultivariateChart': '.plotlib.chart',
+    'SingleChart': '.plotlib.chart',
+    'Dodger': '.plotlib.classify',
+    'HueLabel': '.plotlib.classify',
+    'ShapeLabel': '.plotlib.classify',
+    'SizeLabel': '.plotlib.classify',
+    'AxesFacets': '.plotlib.facets',
+    'LabelFacets': '.plotlib.facets',
+    'StripesFacets': '.plotlib.facets',
+    'flat_unique': '.plotlib.facets',
+    'Bar': '.plotlib.plotter',
+    'Beeswarm': '.plotlib.plotter',
+    'BlandAltman': '.plotlib.plotter',
+    'Box': '.plotlib.plotter',
+    'CapabilityConfidenceInterval': '.plotlib.plotter',
+    'CategoricalObservation': '.plotlib.plotter',
+    'CenterLocation': '.plotlib.plotter',
+    'ConfidenceInterval': '.plotlib.plotter',
+    'DensityCurve': '.plotlib.plotter',
+    'ErrorBar': '.plotlib.plotter',
+    'FittedDensity': '.plotlib.plotter',
+    'GaussianKDE': '.plotlib.plotter',
+    'GaussianKDEContour': '.plotlib.plotter',
+    'GaussianKDEContourUnivariate': '.plotlib.plotter',
+    'HideSubplot': '.plotlib.plotter',
+    'Jitter': '.plotlib.plotter',
+    'Line': '.plotlib.plotter',
+    'LinearRegressionLine': '.plotlib.plotter',
+    'LoessLine': '.plotlib.plotter',
+    'MeanTest': '.plotlib.plotter',
+    'ParallelCoordinate': '.plotlib.plotter',
+    'Pareto': '.plotlib.plotter',
+    'Plotter': '.plotlib.plotter',
+    'Probability': '.plotlib.plotter',
+    'ProportionTest': '.plotlib.plotter',
+    'QuantileBoxes': '.plotlib.plotter',
+    'Scatter': '.plotlib.plotter',
+    'SkipSubplot': '.plotlib.plotter',
+    'SpreadWidth': '.plotlib.plotter',
+    'StandardErrorMean': '.plotlib.plotter',
+    'Stem': '.plotlib.plotter',
+    'StripeLine': '.plotlib.plotter',
+    'StripeSpan': '.plotlib.plotter',
+    'TransformPlotter': '.plotlib.plotter',
+    'VariationTest': '.plotlib.plotter',
+    'Violin': '.plotlib.plotter',
+    'BivariateUnivariateCharts': '.plotlib.precast',
+    'GageRnRCharts': '.plotlib.precast',
+    'GageStudyCharts': '.plotlib.precast',
+    'PairComparisonCharts': '.plotlib.precast',
+    'PairwiseMatrixCharts': '.plotlib.precast',
+    'ParameterRelevanceCharts': '.plotlib.precast',
+    'ProcessCapabilityAnalysisCharts': '.plotlib.precast',
+    'ResidualsCharts': '.plotlib.precast',
+    'bonferroni_ci': '.statistics.confidence',
+    'confidence_to_alpha': '.statistics.confidence',
+    'cp_ci': '.statistics.confidence',
+    'cpk_ci': '.statistics.confidence',
+    'delta_mean_ci': '.statistics.confidence',
+    'delta_proportions_ci': '.statistics.confidence',
+    'delta_stdev_ci': '.statistics.confidence',
+    'delta_variance_ci': '.statistics.confidence',
+    'fit_ci': '.statistics.confidence',
+    'mean_ci': '.statistics.confidence',
+    'median_ci': '.statistics.confidence',
+    'prediction_ci': '.statistics.confidence',
+    'proportion_ci': '.statistics.confidence',
+    'sem': '.statistics.confidence',
+    'stdev_ci': '.statistics.confidence',
+    'variance_ci': '.statistics.confidence',
+    'DistributionEstimator': '.statistics.estimation',
+    'GageEstimator': '.statistics.estimation',
+    'LocationDispersionEstimator': '.statistics.estimation',
+    'Loess': '.statistics.estimation',
+    'Lowess': '.statistics.estimation',
+    'MeasurementUncertainty': '.statistics.estimation',
+    'ProcessEstimator': '.statistics.estimation',
+    'estimate_capability_confidence': '.statistics.estimation',
+    'estimate_distribution': '.statistics.estimation',
+    'estimate_kernel_density': '.statistics.estimation',
+    'estimate_kernel_density_2d': '.statistics.estimation',
+    'estimate_probability_density': '.statistics.estimation',
+    'estimate_resolution': '.statistics.estimation',
+    'root_sum_squares': '.statistics.estimation',
+    'all_normal': '.statistics.hypothesis',
+    'anderson_darling_test': '.statistics.hypothesis',
+    'dunn_test': '.statistics.hypothesis',
+    'f_test': '.statistics.hypothesis',
+    'kolmogorov_smirnov_test': '.statistics.hypothesis',
+    'kurtosis_test': '.statistics.hypothesis',
+    'levene_test': '.statistics.hypothesis',
+    'mean_stability_test': '.statistics.hypothesis',
+    'pairwise_tests': '.statistics.hypothesis',
+    'position_test': '.statistics.hypothesis',
+    'proportions_test': '.statistics.hypothesis',
+    'skew_test': '.statistics.hypothesis',
+    't_test': '.statistics.hypothesis',
+    'variance_stability_test': '.statistics.hypothesis',
+    'variance_test': '.statistics.hypothesis',
+    'UNBOUNDED': '.statistics.montecarlo',
+    'Binning': '.statistics.montecarlo',
+    'RandomProcessValue': '.statistics.montecarlo',
+    'Specification': '.statistics.montecarlo',
+    'SpecLimits': '.statistics.montecarlo',
+    'inclination_displacement': '.statistics.montecarlo',
+    'round_to_nearest': '.statistics.montecarlo',
+}
+
+
+def __getattr__(name: str) -> Any:
+    module_name = _LAZY_SUBMODULES.get(name)
+    if module_name is None:
+        raise AttributeError(f'module {__name__!r} has no attribute {name!r}')
+    module = importlib.import_module(module_name, __name__)
+    value = getattr(module, name)
+    globals()[name] = value
+    return value
+
+
+def __dir__() -> list[str]:
+    return sorted(set(globals()) | set(_LAZY_SUBMODULES))
+
+
+__all__ = [
+    'ANOVA',
+    'CATEGORY',
+    'COLOR',
+    'CONFIG',
+    'DEFAULT',
+    'DIST',
+    'KW',
+    'LABEL',
+    'LINE',
+    'PLOTTER',
+    'RE',
+    'SIGMA_DIFFERENCE',
+    'STR',
+    'UNBOUNDED',
+    'AxesFacets',
+    'Bar',
+    'Beeswarm',
+    'Binning',
+    'BivariateUnivariateCharts',
+    'BlandAltman',
+    'Box',
+    'CapabilityConfidenceInterval',
+    'CategoricalObservation',
+    'CenterLocation',
+    'Chart',
+    'ConfidenceInterval',
+    'DensityCurve',
+    'DistributionEstimator',
+    'Dodger',
+    'ErrorBar',
+    'Factor',
+    'FittedDensity',
+    'FractionalFactorialDesignBuilder',
+    'FullFactorial2kDesignBuilder',
+    'FullFactorialDesignBuilder',
+    'GageEstimator',
+    'GageRnRCharts',
+    'GageRnRModel',
+    'GageStudyCharts',
+    'GageStudyModel',
+    'GaussianKDE',
+    'GaussianKDEContour',
+    'GaussianKDEContourUnivariate',
+    'GeneralizedLinearModel',
+    'HideSubplot',
+    'HueLabel',
+    'Jitter',
+    'JointChart',
+    'LabelFacets',
+    'Line',
+    'LinearModel',
+    'LinearRegressionLine',
+    'LocationDispersionEstimator',
+    'Loess',
+    'LoessLine',
+    'Lowess',
+    'MeanTest',
+    'MeasurementUncertainty',
+    'MultivariateChart',
+    'PairComparisonCharts',
+    'PairwiseMatrixCharts',
+    'ParallelCoordinate',
+    'ParameterRelevanceCharts',
+    'Pareto',
+    'Plotter',
+    'Probability',
+    'ProcessCapabilityAnalysisCharts',
+    'ProcessEstimator',
+    'ProportionTest',
+    'QuantileBoxes',
+    'RandomProcessValue',
+    'ResidualsCharts',
+    'Scatter',
+    'ShapeLabel',
+    'SingleChart',
+    'SizeLabel',
+    'SkipSubplot',
+    'SpecLimits',
+    'Specification',
+    'SpreadWidth',
+    'StandardErrorMean',
+    'Stem',
+    'StripeLine',
+    'StripeSpan',
+    'StripesFacets',
+    'TransformPlotter',
+    'VariationTest',
+    'Violin',
+    '__version__',
+    'all_normal',
+    'anderson_darling_test',
+    'anova_table',
+    'bonferroni_ci',
+    'confidence_to_alpha',
+    'cp_ci',
+    'cpk_ci',
+    'delta_mean_ci',
+    'delta_proportions_ci',
+    'delta_stdev_ci',
+    'delta_variance_ci',
+    'dunn_test',
+    'estimate_capability_confidence',
+    'estimate_distribution',
+    'estimate_kernel_density',
+    'estimate_kernel_density_2d',
+    'estimate_probability_density',
+    'estimate_resolution',
+    'f_test',
+    'fit_ci',
+    'flat_unique',
+    'frames_to_html',
+    'get_default_generators',
+    'get_term_name',
+    'hierarchical',
+    'inclination_displacement',
+    'is_main_parameter',
+    'kolmogorov_smirnov_test',
+    'kurtosis_test',
+    'levene_test',
+    'list_dataset',
+    'load_dataset',
+    'mean_ci',
+    'mean_stability_test',
+    'median_ci',
+    'pairwise_tests',
+    'position_test',
+    'prediction_ci',
+    'proportion_ci',
+    'proportions_test',
+    'root_sum_squares',
+    'round_to_nearest',
+    'sem',
+    'skew_test',
+    'stdev_ci',
+    'style',
+    't_test',
+    'terms_effect',
+    'terms_probability',
+    'uniques',
+    'variance_ci',
+    'variance_inflation_factor',
+    'variance_stability_test',
+    'variance_test',
+]