mars-earth 1.0.1__tar.gz

mars_earth-1.0.1/LICENSE

@@ -0,0 +1,198 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any nature whatsoever resulting
+      from Your use of this software, even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Dylan A Mordaunt
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mars_earth-1.0.1/MANIFEST.in

@@ -0,0 +1 @@
+include README.md

mars_earth-1.0.1/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.4
+Name: mars-earth
+Version: 1.0.1
+Summary: A Pure Python Implementation of Multivariate Adaptive Regression Splines
+Author-email: Dylan A Mordaunt <dylan@mordaunt.dev>
+Maintainer-email: Dylan A Mordaunt <dylan@mordaunt.dev>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/edithatogo/mars
+Project-URL: Documentation, https://edithatogo.github.io/mars/
+Project-URL: Repository, https://github.com/edithatogo/mars
+Project-URL: Changelog, https://github.com/edithatogo/mars/blob/main/CHANGELOG.md
+Project-URL: Bug Tracker, https://github.com/edithatogo/mars/issues
+Keywords: mars,multivariate adaptive regression splines,machine learning,scikit-learn,regression,classification
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: scikit-learn>=1.0.0
+Requires-Dist: matplotlib>=3.4.0
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.3.0; extra == "pandas"
+Provides-Extra: cli
+Requires-Dist: pandas>=1.3.0; extra == "cli"
+Requires-Dist: click>=8.0.0; extra == "cli"
+Requires-Dist: rich>=12.0.0; extra == "cli"
+Provides-Extra: profiling
+Requires-Dist: scalene>=1.5.0; extra == "profiling"
+Requires-Dist: py-spy>=0.3.0; extra == "profiling"
+Provides-Extra: dev
+Requires-Dist: uv>=0.1.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "dev"
+Requires-Dist: pytest-benchmark>=4.0.0; extra == "dev"
+Requires-Dist: pytest-sugar>=0.9.0; extra == "dev"
+Requires-Dist: hypothesis>=6.90.0; extra == "dev"
+Requires-Dist: mutmut>=2.4.0; extra == "dev"
+Requires-Dist: nbmake>=1.4.0; extra == "dev"
+Requires-Dist: diff-cover>=8.0.0; extra == "dev"
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: pre-commit>=3.6.0; extra == "dev"
+Requires-Dist: bandit>=1.7.6; extra == "dev"
+Requires-Dist: safety>=2.4.0; extra == "dev"
+Requires-Dist: mkdocs>=1.5.0; extra == "dev"
+Requires-Dist: mkdocs-material>=9.5.0; extra == "dev"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "dev"
+Requires-Dist: mike>=2.0.0; extra == "dev"
+Requires-Dist: python-semantic-release>=9.0.0; extra == "dev"
+Requires-Dist: pandas>=1.3.0; extra == "dev"
+Requires-Dist: tox>=4.11.0; extra == "dev"
+Dynamic: license-file
+
+# mars: A Pure Python Implementation of Multivariate Adaptive Regression Splines (formerly pymars)
+
+![CI](https://github.com/edithatogo/mars/actions/workflows/ci.yml/badge.svg)
+![Security](https://github.com/edithatogo/mars/actions/workflows/security.yml/badge.svg)
+![Code Quality](https://github.com/edithatogo/mars/actions/workflows/code-quality.yml/badge.svg)
+![Documentation](https://github.com/edithatogo/mars/actions/workflows/docs.yml/badge.svg)
+![Code Coverage](https://codecov.io/gh/edithatogo/mars/branch/main/graph/badge.svg)
+![PyPI](https://img.shields.io/pypi/v/mars.svg)
+![Python Version](https://img.shields.io/pypi/pyversions/mars.svg)
+![License](https://img.shields.io/github/license/edithatogo/mars.svg)
+
+**mars** (formerly **pymars**) is a pure Python implementation of Multivariate Adaptive Regression Splines (MARS), inspired by the popular `py-earth` library by Jason Friedman and an R package `earth` by Stephen Milborrow. The goal of **mars** is to provide an easy-to-install, scikit-learn compatible version of the MARS algorithm without C/Cython dependencies.
+
+## Documentation
+
+Complete documentation is available at: [https://edithatogo.github.io/mars/](https://edithatogo.github.io/mars/) (once GitHub Pages is configured)
+
+## Key Features
+
+- **Pure Python:** Easy to install and use across different platforms.
+- **Scikit-learn Compatible:** Integrates with the scikit-learn ecosystem (estimators, pipelines, model selection tools).
+- **MARS Algorithm:** Implements the core MARS fitting procedure, including:
+  - Forward pass to select basis functions (both hinge and linear terms).
+  - Pruning pass using Generalized Cross-Validation (GCV) to prevent overfitting.
+  - Support for interaction terms (including interactions involving linear terms).
+  - Refined `minspan` and `endspan` controls for knot placement, aligning more closely with `py-earth` behavior (e.g., `minspan` as a cooldown period).
+- **Feature Importance:** Calculation of feature importances using methods like 'nb_subsets' (number of subsets in pruning trace), 'gcv' (GCV improvement), and 'rss' (RSS reduction).
+- **Regression and Classification:** Provides `EarthRegressor` and `EarthClassifier` classes.
+- **Generalized Linear Models:** The `GLMEarth` subclass fits logistic or Poisson models.
+- **Cross‑Validation Helper:** The `EarthCV` class integrates with scikit‑learn's model selection utilities.
+- **Plotting Utilities:** Simple diagnostics built on `matplotlib`.
+- **Advanced Interpretability:** Partial dependence plots, Individual Conditional Expectation (ICE) plots, and model explanation tools.
+- **Comprehensive CLI:** Command-line interface for model fitting, prediction, and evaluation.
+
+## Key Features
+
+- **Pure Python:** Easy to install and use across different platforms.
+- **Scikit-learn Compatible:** Integrates with the scikit-learn ecosystem (estimators, pipelines, model selection tools).
+- **MARS Algorithm:** Implements the core MARS fitting procedure, including:
+  - Forward pass to select basis functions (both hinge and linear terms).
+  - Pruning pass using Generalized Cross-Validation (GCV) to prevent overfitting.
+  - Support for interaction terms (including interactions involving linear terms).
+  - Refined `minspan` and `endspan` controls for knot placement, aligning more closely with `py-earth` behavior (e.g., `minspan` as a cooldown period).
+- **Feature Importance:** Calculation of feature importances using methods like 'nb_subsets' (number of subsets in pruning trace), 'gcv' (GCV improvement), and 'rss' (RSS reduction).
+- **Regression and Classification:** Provides `EarthRegressor` and `EarthClassifier` classes.
+- **Generalized Linear Models:** The `GLMEarth` subclass fits logistic or Poisson models.
+- **Cross‑Validation Helper:** The `EarthCV` class integrates with scikit‑learn's model selection utilities.
+- **Plotting Utilities:** Simple diagnostics built on `matplotlib`.
+- **Advanced Interpretability:** Partial dependence plots, Individual Conditional Expectation (ICE) plots, and model explanation tools.
+- **Comprehensive CLI:** Command-line interface for model fitting, prediction, and evaluation.
+
+## Project Status
+
+This project is currently in the initial development phase. The core algorithm and scikit-learn compatibility are being built. See `ROADMAP.md` and `TODO.md` for more details on the development plan and progress.
+
+## Installation
+
+**Note:** Install `mars` inside a Python virtual environment to silence `pip` warnings about running as root.
+
+`mars` can be installed from TestPyPI:
+
+```bash
+pip install mars
+```
+
+To work with the latest source, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/edithatogo/mars.git
+cd mars
+pip install -e .
+```
+
+If you need to run scikit-learn's full estimator checks, install the optional
+pandas dependency:
+
+```bash
+pip install "mars[pandas]"
+```
+
+After installation you can check the installed version:
+
+```bash
+mars --version
+```
+
+## Running Tests
+
+Install the dependencies listed in `requirements.txt` before running the test
+suite. A small helper script is provided:
+
+```bash
+# Option 1: directly with pip
+pip install -r requirements.txt
+
+# To run the full scikit-learn estimator checks, install the optional pandas
+# dependency as well:
+pip install "mars[pandas]"
+
+# Option 2: using the helper script
+bash scripts/setup_tests.sh
+```
+
+After the dependencies are installed, run the tests with:
+
+```bash
+pytest
+
+```
+
+## Usage
+
+### Quick demos
+
+Run the included demo scripts to see `mars` in action:
+
+```bash
+python -m mars.demos.basic_regression_demo
+python -m mars.demos.basic_classification_demo
+```
+
+### Basic API
+
+```python
+import numpy as np
+import mars as earth
+
+X = np.random.rand(100, 3)
+y = np.sin(X[:, 0]) + X[:, 1]
+
+model = earth.Earth(max_degree=1, penalty=3.0)
+model.fit(X, y)
+predictions = model.predict(X)
+```
+
+## Documentation
+
+The mars project uses a multi-branch documentation approach:
+
+- **Code Documentation**: API and development documentation is available in the [docs branch](https://github.com/edithatogo/mars/tree/docs)
+- **Research Paper**: The academic paper describing mars is available in the [paper branch](https://github.com/edithatogo/mars/tree/paper)
+
+For usage examples and tutorials, check the [examples directory](examples/) in this main branch.
+
+## Contributing
+
+Contributions are welcome! Please see `CONTRIBUTING.md` and `AGENTS.md` for guidelines.
+
+## Citing mars
+
+If you use mars in your research, please cite it as follows:
+
+```bibtex
+@software{mars2026,
+  author = {Mordaunt, Dylan A.},
+  title = {mars: A Pure Python Implementation of Multivariate Adaptive Regression Splines},
+  year = {2026},
+  url = {https://github.com/edithatogo/mars},
+  version = {1.0.1},
+  license = {Apache-2.0},
+}
+```
+
+A `CITATION.cff` file is also included in the repository for easy citation management.
+
+## License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).
+
+## Acknowledgements
+
+- Based on the work of Jerome H. Friedman on MARS.
+- Inspired by the `py-earth` library (scikit-learn-contrib).
+- Inspired by the R `earth` package.

mars_earth-1.0.1/README.md

@@ -0,0 +1,174 @@
+# mars: A Pure Python Implementation of Multivariate Adaptive Regression Splines (formerly pymars)
+
+![CI](https://github.com/edithatogo/mars/actions/workflows/ci.yml/badge.svg)
+![Security](https://github.com/edithatogo/mars/actions/workflows/security.yml/badge.svg)
+![Code Quality](https://github.com/edithatogo/mars/actions/workflows/code-quality.yml/badge.svg)
+![Documentation](https://github.com/edithatogo/mars/actions/workflows/docs.yml/badge.svg)
+![Code Coverage](https://codecov.io/gh/edithatogo/mars/branch/main/graph/badge.svg)
+![PyPI](https://img.shields.io/pypi/v/mars.svg)
+![Python Version](https://img.shields.io/pypi/pyversions/mars.svg)
+![License](https://img.shields.io/github/license/edithatogo/mars.svg)
+
+**mars** (formerly **pymars**) is a pure Python implementation of Multivariate Adaptive Regression Splines (MARS), inspired by the popular `py-earth` library by Jason Friedman and an R package `earth` by Stephen Milborrow. The goal of **mars** is to provide an easy-to-install, scikit-learn compatible version of the MARS algorithm without C/Cython dependencies.
+
+## Documentation
+
+Complete documentation is available at: [https://edithatogo.github.io/mars/](https://edithatogo.github.io/mars/) (once GitHub Pages is configured)
+
+## Key Features
+
+- **Pure Python:** Easy to install and use across different platforms.
+- **Scikit-learn Compatible:** Integrates with the scikit-learn ecosystem (estimators, pipelines, model selection tools).
+- **MARS Algorithm:** Implements the core MARS fitting procedure, including:
+  - Forward pass to select basis functions (both hinge and linear terms).
+  - Pruning pass using Generalized Cross-Validation (GCV) to prevent overfitting.
+  - Support for interaction terms (including interactions involving linear terms).
+  - Refined `minspan` and `endspan` controls for knot placement, aligning more closely with `py-earth` behavior (e.g., `minspan` as a cooldown period).
+- **Feature Importance:** Calculation of feature importances using methods like 'nb_subsets' (number of subsets in pruning trace), 'gcv' (GCV improvement), and 'rss' (RSS reduction).
+- **Regression and Classification:** Provides `EarthRegressor` and `EarthClassifier` classes.
+- **Generalized Linear Models:** The `GLMEarth` subclass fits logistic or Poisson models.
+- **Cross‑Validation Helper:** The `EarthCV` class integrates with scikit‑learn's model selection utilities.
+- **Plotting Utilities:** Simple diagnostics built on `matplotlib`.
+- **Advanced Interpretability:** Partial dependence plots, Individual Conditional Expectation (ICE) plots, and model explanation tools.
+- **Comprehensive CLI:** Command-line interface for model fitting, prediction, and evaluation.
+
+## Key Features
+
+- **Pure Python:** Easy to install and use across different platforms.
+- **Scikit-learn Compatible:** Integrates with the scikit-learn ecosystem (estimators, pipelines, model selection tools).
+- **MARS Algorithm:** Implements the core MARS fitting procedure, including:
+  - Forward pass to select basis functions (both hinge and linear terms).
+  - Pruning pass using Generalized Cross-Validation (GCV) to prevent overfitting.
+  - Support for interaction terms (including interactions involving linear terms).
+  - Refined `minspan` and `endspan` controls for knot placement, aligning more closely with `py-earth` behavior (e.g., `minspan` as a cooldown period).
+- **Feature Importance:** Calculation of feature importances using methods like 'nb_subsets' (number of subsets in pruning trace), 'gcv' (GCV improvement), and 'rss' (RSS reduction).
+- **Regression and Classification:** Provides `EarthRegressor` and `EarthClassifier` classes.
+- **Generalized Linear Models:** The `GLMEarth` subclass fits logistic or Poisson models.
+- **Cross‑Validation Helper:** The `EarthCV` class integrates with scikit‑learn's model selection utilities.
+- **Plotting Utilities:** Simple diagnostics built on `matplotlib`.
+- **Advanced Interpretability:** Partial dependence plots, Individual Conditional Expectation (ICE) plots, and model explanation tools.
+- **Comprehensive CLI:** Command-line interface for model fitting, prediction, and evaluation.
+
+## Project Status
+
+This project is currently in the initial development phase. The core algorithm and scikit-learn compatibility are being built. See `ROADMAP.md` and `TODO.md` for more details on the development plan and progress.
+
+## Installation
+
+**Note:** Install `mars` inside a Python virtual environment to silence `pip` warnings about running as root.
+
+`mars` can be installed from TestPyPI:
+
+```bash
+pip install mars
+```
+
+To work with the latest source, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/edithatogo/mars.git
+cd mars
+pip install -e .
+```
+
+If you need to run scikit-learn's full estimator checks, install the optional
+pandas dependency:
+
+```bash
+pip install "mars[pandas]"
+```
+
+After installation you can check the installed version:
+
+```bash
+mars --version
+```
+
+## Running Tests
+
+Install the dependencies listed in `requirements.txt` before running the test
+suite. A small helper script is provided:
+
+```bash
+# Option 1: directly with pip
+pip install -r requirements.txt
+
+# To run the full scikit-learn estimator checks, install the optional pandas
+# dependency as well:
+pip install "mars[pandas]"
+
+# Option 2: using the helper script
+bash scripts/setup_tests.sh
+```
+
+After the dependencies are installed, run the tests with:
+
+```bash
+pytest
+
+```
+
+## Usage
+
+### Quick demos
+
+Run the included demo scripts to see `mars` in action:
+
+```bash
+python -m mars.demos.basic_regression_demo
+python -m mars.demos.basic_classification_demo
+```
+
+### Basic API
+
+```python
+import numpy as np
+import mars as earth
+
+X = np.random.rand(100, 3)
+y = np.sin(X[:, 0]) + X[:, 1]
+
+model = earth.Earth(max_degree=1, penalty=3.0)
+model.fit(X, y)
+predictions = model.predict(X)
+```
+
+## Documentation
+
+The mars project uses a multi-branch documentation approach:
+
+- **Code Documentation**: API and development documentation is available in the [docs branch](https://github.com/edithatogo/mars/tree/docs)
+- **Research Paper**: The academic paper describing mars is available in the [paper branch](https://github.com/edithatogo/mars/tree/paper)
+
+For usage examples and tutorials, check the [examples directory](examples/) in this main branch.
+
+## Contributing
+
+Contributions are welcome! Please see `CONTRIBUTING.md` and `AGENTS.md` for guidelines.
+
+## Citing mars
+
+If you use mars in your research, please cite it as follows:
+
+```bibtex
+@software{mars2026,
+  author = {Mordaunt, Dylan A.},
+  title = {mars: A Pure Python Implementation of Multivariate Adaptive Regression Splines},
+  year = {2026},
+  url = {https://github.com/edithatogo/mars},
+  version = {1.0.1},
+  license = {Apache-2.0},
+}
+```
+
+A `CITATION.cff` file is also included in the repository for easy citation management.
+
+## License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).
+
+## Acknowledgements
+
+- Based on the work of Jerome H. Friedman on MARS.
+- Inspired by the `py-earth` library (scikit-learn-contrib).
+- Inspired by the R `earth` package.