Merge pull request #1208 from rickecon/pillow

Update uv.lock with pillow 12.3.0 and update .gitignore

Author: jdebacker

.gitignore

@@ -51,5 +51,6 @@ ogcore/tests/OUTPUT_REFORM/*
 regression/OUTPUT_BASELINE/*
 regression/OUTPUT_REFORM*
 .vscode/
+.claude/
 *default.profraw
 *un_api_token.txt

CHANGELOG.md

@@ -5,75 +5,70 @@
 #              to work in that environment (and not on Windows).
 # USAGE: OG-Core$ make [TARGET]
 
-.PHONY=help
+.PHONY: help
 help:
 	@echo "USAGE: make [TARGET]"
 	@echo "TARGETS:"
 	@echo "help       : show help message"
 	@echo "clean      : remove .pyc files and local ogcore package"
 	@echo "install    : build and install local package"
-	@echo "pytest     : generate report for and cleanup after"
-	@echo "             pytest -W ignore -m ''"
-	@echo "cstest     : generate coding-style errors using the"
-	@echo "             pycodestyle (nee pep8) tool"
+	@echo "pytest_all : run all tests"
+	@echo "pytest_ci  : run same set of tests as GitHub Actions CI"
 	@echo "coverage   : generate test coverage report"
-	@echo "git-sync   : synchronize local, origin, and upstream Git repos"
-	@echo "git-pr N=n : create local pr-n branch containing upstream PR"
 	@echo "documentation  : build new Jupyter Book documentation files"
+	@echo "format     : format code using ruff and linecheck"
 
-.PHONY=clean
+.PHONY: clean
 clean:
-	@find . -name *pyc -exec rm {} \;
-	@find . -name *cache -maxdepth 1 -exec rm -r {} \;
-	@conda uninstall ogcore --yes --quiet 2>&1 > /dev/null
+	@find . -name '*.pyc' -delete
+	@find . -maxdepth 1 -name '*cache' -exec rm -r {} +
 
-.PHONY=install
+.PHONY: install
 install:
-	pip install -e .[dev]
+	uv sync --extra dev --extra docs
 
-.PHONY=pytest
-pytest:
-	@cd ogcore ; pytest -W ignore
+.PHONY: pytest_all
+pytest_all:
+	uv run python -m pytest
 
-ogcore_JSON_FILES := $(shell ls -l ./ogcore/*json | awk '{print $$9}')
+.PHONY: pytest_ci
+pytest_ci:
+	uv run python -m pytest -m "not local and not benchmark"
 
-.PHONY=cstest
-cstest:
-	-pycodestyle ogcore
-	-pycodestyle --ignore=E501,E121 $(ogcore_JSON_FILES)
+ogcore_JSON_FILES := $(shell ls -l ./ogcore/*json | awk '{print $$9}')
 
 define coverage-cleanup
 rm -f .coverage htmlcov/*
 endef
 
-COVMARK = ""
+COVMARK = "not local and not benchmark"
 
 OS := $(shell uname -s)
 
-.PHONY=coverage
+.PHONY: coverage
 coverage:
 	@$(coverage-cleanup)
-	@coverage run -m pytest -v -m $(COVMARK) > /dev/null
-	@coverage html --ignore-errors
+	uv run python -m pytest -m $(COVMARK) -n 4 --cov=ogcore --cov-report=html --cov-report=term
 ifeq ($(OS), Darwin) # on Mac OS X
 	@open htmlcov/index.html
 else
 	@echo "Open htmlcov/index.html in browser to view report"
 endif
-	@$(pytest-cleanup)
 
-.PHONY=documentation
+.PHONY: documentation
 documentation:
-	uv run python -m ipykernel install --user --name=ogcore-dev
-	uv run jb clean docs
-	uv run python ./docs/make_params.py
-	uv run python ./docs/make_vars.py
-	uv run jb build ./docs/book
+	uv run --extra docs python -m ipykernel install --user --name=ogcore-dev
+	uv run --extra docs jb clean docs
+	uv run --extra docs python ./docs/make_params.py
+	uv run --extra docs python ./docs/make_vars.py
+	uv run --extra docs jb build ./docs/book
 
+.PHONY: format
 format:
 	uv run ruff format .
 	uv run ruff check . --fix
 	uv run linecheck . --fix
 
+.PHONY: pip-package
 pip-package:
 	uv build

Makefile

@@ -49,6 +49,8 @@ sphinx:
   extra_extensions          : ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
                                'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
                                'alabaster']   # A list of extra extensions to load by Sphinx.
+  local_extensions          :   # Local extensions, "name: path" (path relative to this file)
+    suppress_header_warnings : _ext
   config                    :   # key-value pairs to directly over-ride the Sphinx configuration
     bibtex_reference_style: author_year
     mathjax_path          : https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

docs/book/_config.yml

@@ -0,0 +1,48 @@
+"""Suppress MyST ``myst.header`` warnings for the auto-generated pages.
+
+``docs/book/content/intro/parameters.md`` and ``variables.md`` are written by
+``docs/make_params.py`` and ``docs/make_vars.py``.  Both deliberately place the
+parameter/variable headings two levels below their section heading (H2 to H4),
+which MyST reports as "Non-consecutive header level increase".  MyST reads
+Sphinx's global ``suppress_warnings`` setting, so silencing ``myst.header``
+there would silence it for the whole book.  This extension instead drops those
+records only when they come from the two generated files.
+"""
+
+import logging
+import os
+
+TARGETS = (
+    "content/intro/parameters.md",
+    "content/intro/variables.md",
+)
+SUBTYPE = "[myst.header]"
+
+
+class HeaderWarningFilter(logging.Filter):
+    """Drop ``myst.header`` warnings raised by the generated pages."""
+
+    def filter(self, record):
+        if SUBTYPE not in str(record.msg):
+            return True
+        location = str(getattr(record, "location", "") or "")
+        location = location.replace(os.sep, "/")
+        return not any(target in location for target in TARGETS)
+
+
+def _add_filter(app):
+    log_filter = HeaderWarningFilter()
+    for handler in logging.getLogger("sphinx").handlers:
+        # Insert ahead of Sphinx's own filters: WarningSuppressor increments
+        # the build's warning count and WarningIsErrorFilter raises under
+        # ``-W``, and both run before any filter added with addFilter().
+        handler.filters.insert(0, log_filter)
+
+
+def setup(app):
+    app.connect("builder-inited", _add_filter)
+    return {
+        "version": "1.0",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

docs/book/_ext/suppress_header_warnings.py

@@ -7,6 +7,27 @@ parts:
 - caption: OG-Core API
   chapters:
   - file: content/api/public_api
+    sections:
+    - file: content/api/aggregates
+    - file: content/api/config
+    - file: content/api/demographics
+    - file: content/api/elliptical_u_est
+    - file: content/api/execute
+    - file: content/api/firm
+    - file: content/api/fiscal
+    - file: content/api/household
+    - file: content/api/output_plots
+    - file: content/api/output_tables
+    - file: content/api/parameter_plots
+    - file: content/api/parameter_tables
+    - file: content/api/parameters
+    - file: content/api/pensions
+    - file: content/api/solvers
+    - file: content/api/SS
+    - file: content/api/tax
+    - file: content/api/TPI
+    - file: content/api/txfunc
+    - file: content/api/utils
 - caption: OG-Core Theory
   chapters:
   - file: content/theory/intro

docs/book/_toc.yml

@@ -0,0 +1,13 @@
+.. _SS:
+
+Steady-State Functions
+=================================================
+
+**SS.py modules**
+
+ogcore.SS
+------------------------------------------
+
+.. automodule:: ogcore.SS
+  :members: euler_equation_solver, solve_for_j, inner_loop, SS_solver,
+    SS_fsolve, SS_initial_guesses, run_SS

docs/book/content/api/SS.rst

@@ -0,0 +1,13 @@
+.. _TPI:
+
+Transition Path Functions
+=================================================
+
+**TPI.py modules**
+
+ogcore.TPI
+------------------------------------------
+
+.. automodule:: ogcore.TPI
+  :members: get_initial_SS_values, firstdoughnutring, twist_doughnut,
+    inner_loop, run_TPI

docs/book/content/api/TPI.rst

@@ -0,0 +1,12 @@
+.. _config:
+
+Logging Configuration
+=================================================
+
+**config.py modules**
+
+ogcore.config
+------------------------------------------
+
+.. automodule:: ogcore.config
+  :members: set_logging_level

docs/book/content/api/config.rst

@@ -8,26 +8,4 @@ make up the `OG-Core` model. Below is a list of these modules (in alphabetical
 order) with documentation about how to call each class method and function.
 There is also a link to the source code for each documented member.
 
-.. toctree::
-   :maxdepth: 1
-
-   aggregates
-   config
-   demographics
-   elliptical_u_est
-   execute
-   firm
-   fiscal
-   household
-   output_plots
-   output_tables
-   parameter_plots
-   parameter_tables
-   parameters
-   pensions
-   solvers
-   SS
-   tax
-   TPI
-   txfunc
-   utils
+.. tableofcontents::