Official Parallelization of Yroots

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/Unit_Tests.yml

@@ -1,33 +1,35 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: Unit_Tests
-
 on:
   push:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
-
+  workflow_dispatch:
 permissions:
   contents: read
-
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v3
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
       with:
-        python-version: "3.11"
-    - name: Install dependencies
+        enable-cache: true
+
+    - name: Set up Python 3.14t
+      uses: astral-sh/setup-uv@v5
+      with:
+        python-version: "3.14t"
+
+    - name: Check Python version
       run: |
-        python -m pip install --upgrade pip
-        pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        uv run python --version
+        uv run python -c "import sysconfig; print('Py_GIL_DISABLED =', sysconfig.get_config_var('Py_GIL_DISABLED'))"
+
+    - name: Install dependencies
+      run: uv sync --frozen
+
     - name: Test with pytest
-      run: |
-        pytest tests --ignore=tests/_old_unit_tests
+      run: uv run pytest tests --ignore=tests/_old_unit_tests

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Docs
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.14t"
+      - name: Install dependencies
+        run: uv sync --frozen --group docs
+      - name: Build docs
+        run: uv run sphinx-build docs/source docs/_build/html
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.python-version

@@ -0,0 +1 @@
+3.14t

CombinedNotebook.ipynb

@@ -41,19 +41,21 @@
    "source": [
     "## Setup YRoots\n",
     "\n",
-    "First, in a terminal (Linux/Unix/Mac), navigate to the directory in which you wish to install `yroots`, then download it from github with the following command:\n",
+    "In a terminal, clone the repository and enter the directory:\n",
     "\n",
-    "  ```git\n",
-    "      git clone https://github.com/tylerjarvis/RootFinding.git   \n",
-    "  ```\n",
-    "  \n",
-    "Then make the `yroots` module availabe to Python, use the following command: \n",
+    "    git clone https://github.com/tylerjarvis/RootFinding.git\n",
+    "    cd RootFinding\n",
     "\n",
-    "  ```\n",
-    "      pip install -e ./RootFinding\n",
-    "  ```\n",
+    "Install `yroots` and all its dependencies using [uv](https://docs.astral.sh/uv/):\n",
     "\n",
-    "In addition, you will need to have `numpy`, `numba`, and `scipy` installed in order to run YRoots. See the documentation for the corresponding packages to learn how to install any of these.\n",
+    "    uv sync\n",
+    "\n",
+    "This installs Python 3.14t (the free-threaded build required by YRoots) along with `numpy`, `numba`, `scipy`, and all other dependencies into an isolated environment at `.venv/`.\n",
+    "To run this notebook, open it in your editor of choice (VS Code, JupyterLab, classic Jupyter) and select `.venv/bin/python` as the kernel.\n",
+    "\n",
+    "If you prefer plain `pip` and already have Python 3.14t with `pip` installed, you can install YRoots directly:\n",
+    "\n",
+    "    pip install -e .\n",
     "\n",
     "<u>Before proceeding in this tutorial, you will need to complete the above process and run the following import statements: </u>"
    ]

README.md

@@ -2,7 +2,7 @@
 
 YRoots is a Python package designed for numerical rootfinding of multivariate systems of equations.
 
-For a tutorial on YRoots syntax, set-up and examples on how to use it with different function systems, see [YRoots Tutorial](https://github.com/tylerjarvis/RootFinding/blob/main/YRootsTutorial.ipynb) and for a more detailed demonstration of the code's capabilities on solving more challenging problems, see [YRoots Demo](https://github.com/tylerjarvis/RootFinding/blob/main/YRootsDemo.ipynb). 
+For a tutorial on YRoots syntax, set-up, and examples on how to use it with different function systems, see [Combined Notebook](https://github.com/tylerjarvis/RootFinding/blob/main/CombinedNotebook.ipynb). 
 
 Documentation is posted at https://tylerjarvis.github.io/RootFinding/
 
@@ -13,26 +13,37 @@ This project was supported in part by the National Science Foundation, grant num
 <!-- [![PyPI version](https://badge.fury.io/py/RootFinding.svg)](https://badge.fury.io/py/RootFinding) -->
 <!-- [![Code Health](https://landscape.io/github/tylerjarvis/RootFinding/pypackage/landscape.svg)](https://landscape.io/github/tylerjarvis/RootFinding/pypackage) -->
 
-<!-- [![Build Status](https://travis-ci.com/tylerjarvis/RootFinding.svg?branch=master)](https://travis-ci.com/tylerjarvis/RootFinding) -->
-<!-- [![codecov](https://codecov.io/gh/mtmoncur/tylerjarvis/branch/master/graphs/badge.svg)](https://codecov.io/gh/tylerjarvis/RootFinding) -->
-<!-- [![PyPI version](https://badge.fury.io/py/RootFinding.svg)](https://badge.fury.io/py/RootFinding) -->
-<!-- [![Code Health](https://landscape.io/github/tylerjarvis/RootFinding/pypackage/landscape.svg)](https://landscape.io/github/tylerjarvis/RootFinding/pypackage) -->
-
 ### Requirements
-At least:
-* Python 3.10
-* Pip 21.1
-* Numpy 1.22.0
-* Numba 0.37.0
-* Scipy 1.10.0
-* Sympy 1.5.1
+* Python 3.14t (free-threaded build — see note below)
+* NumPy ≥ 2.4.4
+* Numba ≥ 0.65.1
+* SciPy ≥ 1.17.1
+* SymPy ≥ 1.12
+
+> **Why 3.14t?** YRoots requires the free-threaded build of Python 3.14, which runs without the Global Interpreter Lock (GIL) for better parallelism. The `t` suffix identifies this build — it is a different download from the standard Python 3.14.
 
 ## Installation
 
-`$ pip install git+https://github.com/tylerjarvis/RootFinding.git`
+With uv (recommended):
+```
+uv python install 3.14t
+uv pip install git+https://github.com/tylerjarvis/RootFinding.git
+```
+Or clone and install for development:
+
+```
+git clone https://github.com/tylerjarvis/RootFinding.git
+cd RootFinding
+uv sync
+```
 
-The package can then by imported using `import yroots`.
+With pip (requires Python 3.14t already installed):
+
+```
+pip install git+https://github.com/tylerjarvis/RootFinding.git
+```
 
+The package can then be imported using `import yroots`.
 (We are currently working on adding the yroots package to The Python Package Index)
 
 ## Usage
@@ -54,7 +65,7 @@ b = np.array([0,1]) #upper bounds on x and y
 yr.solve([f,g],a,b)
 ```
 
-If the system includes polynomials, there are specialized `Polynomial` objects which may be allow for faster solving. See [Combined Notebook](https://github.com/tylerjarvis/RootFinding/blob/main/CombinedNotebook.ipynb) for more details.
+If the system includes polynomials, there are specialized `Polynomial` objects which may allow for faster solving. See [Combined Notebook](https://github.com/tylerjarvis/RootFinding/blob/main/CombinedNotebook.ipynb) for more details.
 
 
 ## Examples of Applications