openpls-engine 0.7.0a2__py3-none-any.whl

openpls_engine-0.7.0a2.dist-info/METADATA

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: openpls-engine
+Version: 0.7.0a2
+Summary: PLS-SEM compute engine, a maintained fork of plspm-python with extended metrics (SRMR, d_ULS, HTMT, Q², MGA) powering OpenPLS.
+Home-page: https://github.com/googlecloudplatform/plspm-python
+Author: Jez Humble
+Author-email: Johannes Jacob <johannespjacob@gmail.com>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/jojacobsen/openpls-engine
+Project-URL: Issues, https://github.com/jojacobsen/openpls-engine/issues
+Project-URL: OpenPLS web app, https://openpls.app
+Project-URL: Upstream (plspm-python), https://github.com/googlecloudplatform/plspm-python
+Keywords: pls-sem,structural-equation-modeling,statistics,pls,sem
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=1.5
+Requires-Dist: numpy>=1.23
+Requires-Dist: scipy>=1.10
+Requires-Dist: statsmodels>=0.14
+Requires-Dist: scikit-learn>=1.2
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# OpenPLS Engine
+
+[![CI](https://github.com/jojacobsen/openpls-engine/actions/workflows/ci.yml/badge.svg)](https://github.com/jojacobsen/openpls-engine/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/openpls-engine.svg)](https://pypi.org/project/openpls-engine/)
+[![Python versions](https://img.shields.io/pypi/pyversions/openpls-engine.svg)](https://pypi.org/project/openpls-engine/)
+[![License: GPL-3.0-or-later](https://img.shields.io/badge/license-GPLv3+-blue.svg)](LICENSE)
+
+The compute engine behind [OpenPLS](https://openpls.app), a Python 3 library
+for Partial Least Squares Structural Equation Modeling (PLS-SEM).
+
+`openpls-engine` is a fork of
+[`plspm-python`](https://github.com/googlecloudplatform/plspm-python) by Jez
+Humble (Google). It keeps the original algorithm intact and adds the metrics
+and quality criteria that modern PLS-SEM reporting requires: HTMT, SRMR,
+d_ULS, adjusted R², BIC, Stone-Geisser Q², Cronbach α, Dijkstra-Henseler ρ,
+multi-group analysis, and a progress-streaming long bootstrap.
+
+The engine also powers [OpenPLS](https://openpls.app) (the hosted web
+application) and the CLI / Docker self-host distribution planned for the next
+phase of the roadmap.
+
+> **Status: pre-release (`0.7.0a1`).** All planned ports from the OpenPLS web
+> app are in. Numerical alignment with reference implementations and PyPI
+> publication are tracked in [TODO.md](TODO.md). See
+> [CHANGELOG.md](CHANGELOG.md) for the version history.
+
+## Why fork
+
+* Upstream has not seen a release since 2020.
+* OpenPLS adds substantial extensions: SRMR, d_ULS, HTMT, Q², adjusted R²,
+  BIC, multi-group analysis (MGA), permutation tests, mean replacement, and a
+  long-running bootstrap with BCa confidence intervals.
+* The OpenPLS hosted product depends on a single source of truth for the
+  algorithm; a maintained, versioned package makes that practical.
+* The intention is to release `openpls-engine` on PyPI once the API
+  stabilizes (see TODO).
+
+## Installation
+
+The package is not on PyPI yet. To use it from source:
+
+```sh
+git clone https://github.com/jojacobsen/openpls-engine.git
+cd openpls-engine
+python3 -m pip install -e .
+```
+
+Once published, installation will be:
+
+```sh
+pip install openpls-engine
+```
+
+## Development
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements-dev.txt
+pip install -e .
+
+pytest          # run the test suite
+ruff check .    # lint
+```
+
+CI runs lint and tests on Python 3.10 through 3.13 against every push and
+pull request against `main`.
+
+## Versioning
+
+`openpls-engine` follows [Semantic Versioning](https://semver.org). The
+current pre-1.0 line is `0.x`. Tagged releases (`v0.7.0`, `v1.0.0`, ...)
+trigger a GitHub Actions workflow that builds the package and publishes it
+to PyPI via OIDC trusted publishing. The version is the single source of
+truth in [`pyproject.toml`](pyproject.toml) and is exposed at runtime as
+`plspm.__version__`.
+
+See [CHANGELOG.md](CHANGELOG.md) for the per-version history.
+
+## Usage
+
+The public API mirrors upstream `plspm` 0.5.7. The
+[upstream documentation](https://plspm.readthedocs.io/) is still authoritative
+for the inherited interface; OpenPLS-specific docs will land alongside the
+metric extensions.
+
+```py
+import pandas as pd
+import plspm.config as c
+from plspm.plspm import Plspm
+from plspm.scheme import Scheme
+from plspm.mode import Mode
+
+satisfaction = pd.read_csv("tests/data/satisfaction.csv", index_col=0)
+
+structure = c.Structure()
+structure.add_path(["IMAG"], ["EXPE", "SAT", "LOY"])
+structure.add_path(["EXPE"], ["QUAL", "VAL", "SAT"])
+structure.add_path(["QUAL"], ["VAL", "SAT"])
+structure.add_path(["VAL"], ["SAT"])
+structure.add_path(["SAT"], ["LOY"])
+
+config = c.Config(structure.path(), scaled=False)
+for lv in ["IMAG", "EXPE", "QUAL", "VAL", "SAT", "LOY"]:
+    config.add_lv_with_columns_named(lv, Mode.A, satisfaction, lv.lower())
+
+result = Plspm(satisfaction, config, Scheme.CENTROID)
+print(result.inner_summary())
+print(result.path_coefficients())
+```
+
+## License
+
+GNU General Public License v3.0, see [LICENSE](LICENSE). Inherited from
+upstream `plspm-python` (also GPL-3.0).
+
+## Attribution
+
+This project is a fork of
+[googlecloudplatform/plspm-python](https://github.com/googlecloudplatform/plspm-python)
+by Jez Humble. The upstream R package
+[plspm](https://github.com/gastonstat/plspm) by Gaston Sanchez and the
+[seminr](https://github.com/sem-in-r/seminr) package by Soumya Ray and
+Nicholas Danks remain the conceptual references for the algorithm. See
+[ATTRIBUTION.md](ATTRIBUTION.md) for details.
+
+OpenPLS is an independent project and not affiliated with Google.

openpls_engine-0.7.0a2.dist-info/RECORD

@@ -0,0 +1,24 @@
+openpls_engine-0.7.0a2.dist-info/licenses/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+plspm/__init__.py,sha256=VUhao09juqYGQpSDQ8_UMn1pXgW2X319jKkIMPqZOTU,923
+plspm/bootstrap.py,sha256=NtnCxAXPCGzLmnfr4BbQnQYymadD_4t41LvqmWT5sc8,7127
+plspm/config.py,sha256=tVEJFULNmozRDSzT0U-UjYWG9Q7Zt4hPPwnuEIk8Nu4,16973
+plspm/estimator.py,sha256=U2vFiIT1zEDnYXZfx5Ui2QHRwVoiXMoiUB049x8QeSQ,3098
+plspm/fit.py,sha256=TDSu7D3v7YSCyjWQ1Ubaz87TyGAM8IrlIdx02XQIpIQ,4201
+plspm/htmt.py,sha256=XQ3n4N0FC0lPj3VkTL4WkRVczlL9yx3TM2Mo22NPLE8,4545
+plspm/inner_model.py,sha256=Xz7kzKtNyQg5ABQGL1EY1GSBwAIF-vk7nZMiPJ5_Kig,5136
+plspm/inner_summary.py,sha256=Y6jMWhWKhL-NOBQQ4nOYGnqwcE3uJRZY_mabq2cTr_4,4027
+plspm/long_bootstrap.py,sha256=88Xmeoi8o7xeGENTg06syDjt0SukmHxlAvsumRVN9pE,12876
+plspm/mga.py,sha256=H3IJjx6lVQgfz1Eh_Zxwa9eEx7Z4FansBCQ9qv77mK4,8339
+plspm/mode.py,sha256=xPVpYQRz8CYMgma4GS8YBpOdLmQGR9nezWE-k6nhrfk,3021
+plspm/outer_model.py,sha256=fOv0vIHxAHSxyQJGqeGvnvsWbl7SsJTtt8UTGGrlIOY,2107
+plspm/plspm.py,sha256=Eed5hkLvN59KdR4HT8Q1fGZ2_9b4ugwhnp-n1F6Wypo,11107
+plspm/q_squared.py,sha256=zBhZP6VWCQzUBOh0bgXdkE1yoeIa4npR3Aw1qHHl0Dg,5793
+plspm/scale.py,sha256=gvVZ0e27sLhgPJglDwqzt1_9_iMYeI9GLJ0xLbnZ0Lg,4046
+plspm/scheme.py,sha256=UvmgXyG8NOlHKwaFhTKS-5C6c4yfwRqyVU87jd7JLtk,2174
+plspm/unidimensionality.py,sha256=Ssn3wrce7RjykDy7Eg3S7f_hH1eHkzsz1l_4Jl4Ti9Y,4033
+plspm/util.py,sha256=zWsFznTCOZjqEiDovzs7FAdSQdICLd0yCjqERTvipxE,5359
+plspm/weights.py,sha256=L0IjntNhRQuzgHPhKN7Wamc0o6xA1t4TZ6lBTvolwaQ,9392
+openpls_engine-0.7.0a2.dist-info/METADATA,sha256=cZHnGLNwu7f8HZmO0EjCdJQoOerpZScdUd0YnrEy3cI,6132
+openpls_engine-0.7.0a2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+openpls_engine-0.7.0a2.dist-info/top_level.txt,sha256=guUiqVpR9brhIEhtL9j9GCHzK6wFwN7OIn2m5QGXl_0,6
+openpls_engine-0.7.0a2.dist-info/RECORD,,

openpls_engine-0.7.0a2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+