Switch to uv and ruff; remove setup.py and pytest.ini

- Replace setup.py with full [project] metadata in pyproject.toml
- Move pytest.ini config into [tool.pytest.ini_options] in pyproject.toml
- Replace [tool.black] with [tool.ruff] (line-length = 79) in pyproject.toml
- Add [project.optional-dependencies] dev and docs groups
- Rename check_black.yml -> check_ruff.yml; use uvx ruff format/check
- Update build_and_test.yml to use astral-sh/setup-uv instead of conda
- Update deploy_docs.yml and docs_check.yml to use uv
- Update publish_to_pypi.yml to use uv build
- Update Makefile format target (ruff) and pip-package target (uv build)
- Update environment.yml: replace black/pylint with ruff, drop setuptools
- Update README.md: replace black badge with ruff, update install instructions

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: jdebacker

.github/workflows/build_and_test.yml

@@ -4,7 +4,6 @@ on:
     paths:
       - '**.yml'
       - '**.toml'
-      - '**.ini'
       - '**.py'
       - '**.json'
       - '**.csv'
@@ -14,7 +13,6 @@ on:
     paths:
       - '**.yml'
       - '**.toml'
-      - '**.ini'
       - '**.py'
       - '**.json'
       - '**.csv'
@@ -33,24 +31,14 @@ jobs:
         uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - name: Setup Miniconda using Python ${{ matrix.python-version }}
-        uses: conda-incubator/setup-miniconda@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          miniconda-version: "latest"
-          auto-update-conda: true
-          activate-environment: ogcore-dev
-          environment-file: environment.yml
           python-version: ${{ matrix.python-version }}
-          auto-activate-base: false
-      - name: Build
-        shell: bash -l {0}
-        run: |
-          pip install -e .
+      - name: Install package and dependencies
+        run: uv pip install -e ".[dev]" --system
       - name: Test
-        shell: bash -l {0}
-        working-directory: ./
-        run: |
-          python -m pytest -m "not local and not benchmark" --cov=./ --cov-report=xml
+        run: python -m pytest -m "not local and not benchmark" --cov=./ --cov-report=xml
       - name: Upload coverage to Codecov
         if: matrix.os == 'ubuntu-latest' && contains(github.repository, 'PSLmodels/OG-Core')
         uses: codecov/codecov-action@v4

.github/workflows/check_black.yml

@@ -0,0 +1,14 @@
+name: Check Ruff formatting and linting
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - name: Check formatting with Ruff
+        run: uvx ruff format --check .
+      - name: Check linting with Ruff
+        run: uvx ruff check .

.github/workflows/check_ruff.yml

@@ -21,19 +21,16 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Setup Miniconda
-        uses: conda-incubator/setup-miniconda@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          miniconda-version: "latest"
-          activate-environment: ogcore-dev
-          environment-file: environment.yml
           python-version: "3.13"
-          auto-activate-base: false
+
+      - name: Install package and dependencies
+        run: uv pip install -e ".[dev,docs]" --system
 
       - name: Build # Build Jupyter Book
-        shell: bash -l {0}
         run: |
-          pip install -e .
           python -m ipykernel install --user --name=ogcore-dev
           make build-docs
 

.github/workflows/deploy_docs.yml

@@ -19,18 +19,15 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Setup Miniconda
-        uses: conda-incubator/setup-miniconda@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          miniconda-version: "latest"
-          activate-environment: ogcore-dev
-          environment-file: environment.yml
           python-version: "3.13"
-          auto-activate-base: false
+
+      - name: Install package and dependencies
+        run: uv pip install -e ".[dev,docs]" --system
 
       - name: Build # Build Jupyter Book
-        shell: bash -l {0}
         run: |
-          pip install -e .
           python -m ipykernel install --user --name=ogcore-dev
           make build-docs

.github/workflows/docs_check.yml

@@ -13,12 +13,12 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
           python-version: "3.13"
       - name: Build package
-        run: make pip-package
+        run: uv build
       - name: Publish a Python distribution to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.github/workflows/publish_to_pypi.yml

@@ -71,10 +71,9 @@ build-docs:
 	@cd ./docs ; python make_params.py; python make_vars.py; jb build ./book
 
 format:
-	black . -l 79
+	ruff format .
+	ruff check . --fix
 	linecheck . --fix
 
 pip-package:
-	pip install wheel
-	pip install setuptools
-	python setup.py sdist bdist_wheel
+	uv build

Makefile

@@ -3,8 +3,8 @@
 | | |
 | --- | --- |
 | Org | [![PSL cataloged](https://img.shields.io/badge/PSL-cataloged-a0a0a0.svg)](https://www.PSLmodels.org) [![OS License: CCO-1.0](https://img.shields.io/badge/OS%20License-CCO%201.0-yellow)](https://github.com/PSLmodels/OG-Core/blob/master/LICENSE) [![Jupyter Book Badge](https://raw.githubusercontent.com/jupyter-book/jupyter-book/next/docs/media/images/badge.svg)](https://pslmodels.github.io/OG-Core/) |
-| Package | [![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3129/) [![Python 3.13](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/release/python-3137/)  [![PyPI Latest Release](https://img.shields.io/pypi/v/ogcore.svg)](https://pypi.org/project/ogcore/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogcore.svg?label=PyPI%20downloads)](https://pypi.org/project/ogcore/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |
-| Testing | ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/build_and_test.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/deploy_docs.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/check_black.yml/badge.svg?branch=master) [![Codecov](https://codecov.io/gh/PSLmodels/OG-Core/branch/master/graph/badge.svg)](https://codecov.io/gh/PSLmodels/OG-Core) |
+| Package | [![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3129/) [![Python 3.13](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/release/python-3137/)  [![PyPI Latest Release](https://img.shields.io/pypi/v/ogcore.svg)](https://pypi.org/project/ogcore/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogcore.svg?label=PyPI%20downloads)](https://pypi.org/project/ogcore/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) |
+| Testing | ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/build_and_test.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/deploy_docs.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/check_ruff.yml/badge.svg?branch=master) [![Codecov](https://codecov.io/gh/PSLmodels/OG-Core/branch/master/graph/badge.svg)](https://codecov.io/gh/PSLmodels/OG-Core) |
 
 
 OG-Core is an overlapping-generations (OG) model core theory, logic, and solution method algorithms that allow for dynamic general equilibrium analysis of fiscal policy. OG-Core provides a general framework and is a dependency of several country-specific OG model caliibrations, as listed in the table belowsuch as [OG-USA](https://github.com/PSLmodels/OG-USA) and [OG-UK](https://github.com/PSLmodels/OG-UK). The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available [here](https://pslmodels.github.io/OG-Core).
@@ -24,13 +24,12 @@ The model is constantly under development, and model components could change sig
 
 ## Using/contributing to OG-Core
 
-There are two primary methods for installing and running OG-Core on your computer locally. The first and simplest method is to download the most recent `ogcore` Python package from the Python Package Index ([PyPI.org]()). A second option is to fork and clone the most recent version of OG-Core from its GitHub repository and create the conda environment for the `ogcore` package. We detail both of these methods below.
+There are two primary methods for installing and running OG-Core on your computer locally. The first and simplest method is to download the most recent `ogcore` Python package from the Python Package Index ([PyPI.org](https://pypi.org/project/ogcore/)). A second option is to fork and clone the most recent version of OG-Core from its GitHub repository and install the `ogcore` package with its development dependencies using `uv`. We detail both of these methods below.
 
 
 ### Installing and Running OG-Core from Python Package Index (PyPI.org)
 
-* Open your terminal (or Conda command prompt), and make sure you have the most recent version of `pip` (the Python Index Package manager) by typing on a Unix/macOS machine `python3 -m pip install --upgrade pip` or on a Windows machine `py -m pip install --upgrade pip`.
-* Install the [`ogcore`](https://pypi.org/project/ogcore/) package from the Python Package Index by typing `pip install ogcore`.
+* Open your terminal and install the [`ogcore`](https://pypi.org/project/ogcore/) package from the Python Package Index by typing `pip install ogcore`.
 * Navigate to a folder `./YourFolderName/` where you want to save scripts to run OG-Core and output from the simulations in those scripts.
 * Save the python script [`run_ogcore_example.py`](https://github.com/PSLmodels/OG-Core/blob/master/run_examples/run_ogcore_example.py) from the OG-Core GitHub repository in the folder where you are working on your local machine `./YourFolderName/run_ogcore_example.py`.
 * Run the model with an example reform from terminal/command prompt by typing `python run_ogcore_example.py`
@@ -60,11 +59,9 @@ The CSV output file `./ogcore_example_output.csv` can be compared to the [`./run
 
 ### Installing and Running OG-Core from GitHub repository
 
-* Install the [Anaconda distribution](https://www.anaconda.com/distribution/) of Python
+* Install [`uv`](https://docs.astral.sh/uv/) by following the [installation instructions](https://docs.astral.sh/uv/getting-started/installation/) for your platform (or simply run `pip install uv`)
 * Clone this repository to a directory on your computer
-* From the terminal (or Conda command prompt), navigate to the directory to which you cloned this repository and run `conda env create -f environment.yml`
-* Then, `conda activate ogcore-dev`
-* Then install by `pip install -e .`
+* From the terminal, navigate to the directory to which you cloned this repository and run `uv pip install -e ".[dev]"` to install the package and all development dependencies
 * Navigate to `./run_examples`
 * Run the model with an example reform from terminal/command prompt by typing `python run_ogcore_example.py`
 * You can adjust the `./run_examples/run_ogcore_example.py` script by modifying model parameters specified in the `og_spec` dictionary.

README.md

@@ -5,7 +5,6 @@ dependencies:
 - python>3.11, <3.14
 - numpy
 - ipython
-- setuptools
 - scipy>=1.7.1
 - pandas>=1.2.5
 - numba
@@ -24,11 +23,10 @@ dependencies:
 - pytest>=6.0
 - pytest-cov
 - pytest-xdist
-- pylint
 - coverage
 - requests
 - openpyxl>=3.1.2
-- black>=24.1.1
+- ruff
 - pip
 - pip:
   - pygam

environment.yml

@@ -2,14 +2,99 @@
 requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
-# Configuration for Black.
+[project]
+name = "ogcore"
+version = "0.15.4"
+authors = [
+    {name = "Jason DeBacker and Richard W. Evans"},
+]
+description = "A general equilibrium overlapping generations model for fiscal policy analysis"
+readme = "README.md"
+license = {text = "CC0 1.0 Universal (CC0 1.0) Public Domain Dedication"}
+requires-python = ">=3.11, <3.14"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "numpy",
+    "scipy>=1.7.1",
+    "pandas>=1.2.5",
+    "numba",
+    "matplotlib",
+    "dask>=2.30.0",
+    "distributed>=2.30.1",
+    "paramtools>=0.20.0",
+    "requests",
+    "pygam",
+]
 
-# NOTE: you have to use single-quoted strings in TOML for regular expressions.
-# It's the equivalent of r-strings in Python.  Multiline strings are treated as
-# verbose regular expressions by Black.  Use [ ] to denote a significant space
-# character.
+[project.urls]
+Homepage = "https://github.com/PSLmodels/OG-Core/"
+"Issue Tracker" = "https://github.com/PSLmodels/OG-Core/issues"
 
-[tool.black]
+[project.optional-dependencies]
+dev = [
+    "pytest>=6.0",
+    "pytest-cov",
+    "pytest-xdist",
+    "coverage",
+    "ruff",
+    "openpyxl>=3.1.2",
+    "linecheck",
+]
+docs = [
+    "jupyter-book<2.0.0",
+    "jupyter",
+    "ipykernel",
+    "sphinx>=3.5.4",
+    "sphinx-argparse",
+    "sphinxcontrib-bibtex>=2.0.0",
+    "sphinx-math-dollar",
+    "pydata-sphinx-theme",
+]
+
+[tool.setuptools.packages.find]
+include = ["ogcore*"]
+
+[tool.setuptools.package-data]
+ogcore = [
+    "default_parameters.json",
+    "model_variables.json",
+    "OGcorePlots.mplstyle",
+]
+
+[tool.ruff]
 line-length = 79
-target-version = ["py312", "py313"]
-include = '\.pyi?$'
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "W"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = ["tests"]
+filterwarnings = [
+    "ignore::RuntimeWarning:.*invalid value encountered.*",
+    "ignore::RuntimeWarning:.*divide by zero encountered in divide.*",
+    "ignore::RuntimeWarning:.*invalid value encountered in power.*",
+]
+markers = [
+    "local: marks tests that run locally and not on GH Actions (mostly due to run time)",
+    "benchmark: marks tests that measure performance and memory usage",
+    "distributed: marks tests that use distributed Dask clients",
+    "memory: marks tests focused on memory usage measurement",
+    "performance: marks tests focused on compute time measurement",
+    "slow: marks tests that take longer to run",
+    "real: marks tests using real OG-Core tax function code",
+    "platform: marks tests for platform-specific optimization",
+]