ogeth 0.1.0__tar.gz → 0.3.0__tar.gz

{ogeth-0.1.0/ogeth.egg-info → ogeth-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ogeth
-Version: 0.1.0
+Version: 0.3.0
 Summary: Ethiopia Calibration for OG-Core
 Author: Marcelo LaFleur, Richard W. Evans, and Jason DeBacker
 License: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
@@ -14,12 +14,11 @@ Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: <3.14,>=3.11
+Requires-Python: <3.14,>=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
@@ -36,7 +35,7 @@ Requires-Dist: openpyxl>=3.1.2
 Requires-Dist: statsmodels
 Requires-Dist: linearmodels
 Requires-Dist: linecheck
-Requires-Dist: ogcore>=0.14.11
+Requires-Dist: ogcore>=0.20.0
 Provides-Extra: dev
 Requires-Dist: pytest>=6.0; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -47,7 +46,7 @@ Requires-Dist: ipython; extra == "dev"
 Requires-Dist: ipykernel; extra == "dev"
 Requires-Dist: jupyter; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: jupyter-book<2.0.0; extra == "docs"
+Requires-Dist: jupyter-book<2.0,>=1.0; extra == "docs"
 Requires-Dist: sphinx>=3.5.4; extra == "docs"
 Requires-Dist: sphinx-book-theme>=0.1.3; extra == "docs"
 Requires-Dist: sphinx-argparse; extra == "docs"
@@ -69,28 +68,100 @@ OG-ETH is an overlapping-generations (OG) model that allows for dynamic general
 
 ## Using and contributing to OG-ETH
 
-There are two primary methods for installing and running OG-ETH on your computer locally. The first and simplest method is to download the most recent `ogeth` Python package from the Python Package Index ([PyPI.org](https://pypi.org/project/ogeth/)). The second option is to fork and clone the most recent version of OG-ETH from its GitHub repository and install the `ogeth` package with its development dependencies using `uv`. Both methods are detailed below.
+Install and run OG-ETH by cloning this GitHub repository and installing the `ogeth` package with its dependencies using [`uv`](https://docs.astral.sh/uv/), as detailed below. (Installing the `ogeth` package from [PyPI](https://pypi.org/project/ogeth/) with `pip` is no longer the recommended path: on the Python versions many machines ship, `pip` either refuses the current release outright — as on the Python 3.9 built into macOS — or silently pairs it with an older `ogcore` than the model is tested against, and even on a supported Python the PyPI route does not pin the `ogcore` version the repository is tested against. The `uv` workflow installs the exact tested versions of every dependency, including a compatible Python interpreter.)
 
-### Installing and Running OG-ETH from PyPI
+### Installation
 
-* On macOS, first install Xcode Command Line Tools (in Terminal: `xcode-select --install`).
-* Open your terminal and install the [`ogeth`](https://pypi.org/project/ogeth/) package from the Python Package Index by typing `pip install ogeth`.
-* Navigate to a folder `./YourFolderName/` where you want to save scripts to run OG-ETH and output from the simulations in those scripts.
-* Copy the python script [`run_og_eth.py`](https://github.com/EAPD-DRB/OG-ETH/blob/main/examples/run_og_eth.py) from the OG-ETH GitHub repository into your folder as `./YourFolderName/run_og_eth.py`.
-* Run the model with an example reform from terminal/command prompt by typing `python run_og_eth.py`.
+There are two ways to install OG-ETH: the easy way, using the OG model family's universal installer, and a manual install that runs the same steps one command at a time. Both start from a terminal, put the model in a new OG-ETH folder inside your current directory (a freshly opened terminal starts in your home folder), and need git.
 
-### Installing and Running OG-ETH from the GitHub repository
+#### Before you start: git
+
+On a Mac where you have never used git before, run this line first and accept the dialog that appears:
+
+```
+xcode-select --install
+```
+
+On Windows, install Git first (skip this if you already have it):
+
+```
+winget install --id Git.Git -e --source winget
+```
+
+#### The easy way: the universal installer
+
+The OG model family has a [universal installer](https://github.com/PSLmodels/OG-Core/blob/master/scripts/QUICK_INSTALL.md) that installs the uv tool, downloads the model, builds its environment, and verifies it — for OG-ETH or any of its sibling country models.
+
+On macOS and Linux, paste:
+
+```
+curl -fsSL https://raw.githubusercontent.com/PSLmodels/OG-Core/master/scripts/install.sh -o og-install.sh
+bash og-install.sh --repo og-eth --yes
+```
+
+On Windows (PowerShell), paste:
+
+```
+$f = "$env:TEMP\og-install.ps1"; irm https://raw.githubusercontent.com/PSLmodels/OG-Core/master/scripts/install.ps1 -OutFile $f; powershell -ExecutionPolicy Bypass -File $f -Repo og-eth -Yes
+```
+
+When the installer finishes, run the example. On macOS and Linux, paste:
+
+```
+source $HOME/.local/bin/env
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+On Windows, open a new PowerShell window (so the just-installed tools are found) and paste:
+
+```
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+#### Manual install
+
+The same setup as individual commands. On macOS and Linux, paste:
+
+```
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source $HOME/.local/bin/env
+git clone https://github.com/EAPD-DRB/OG-ETH.git
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+The second line makes the just-installed uv available in the current terminal; from your next terminal session it is available automatically.
+
+On Windows (PowerShell), install uv:
+
+```
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Then open a new PowerShell window (so the just-installed tools are found) and paste:
+
+```
+git clone https://github.com/EAPD-DRB/OG-ETH.git
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+#### What happens
+
+The first `uv run` creates the project environment if it does not exist yet — downloading a compatible Python interpreter if needed and installing the exact locked dependencies — and then runs the example. Early in the run you may be asked for a UN API token; just press return, and the model reads the same population data from a public mirror and continues. A full baseline-plus-reform run takes from 35 minutes to more than two hours; when it finishes, its plots and tables are saved under `./examples/OG-ETH-Example/` (see the list of outputs below).
+
+### Installing for development or contributing
 
-* On macOS, first install Xcode Command Line Tools (in Terminal: `xcode-select --install`).
-* 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`).
 * Fork this repository and clone your fork to a directory on your computer.
-* From the terminal, navigate to the cloned directory and run `uv sync --extra dev` to create a local `.venv` and install OG-ETH with its development dependencies. `uv` will also download a compatible Python interpreter if you don't already have one.
+* From the terminal, navigate to the cloned directory and run `uv sync --extra dev` to create a local `.venv` and install OG-ETH with its development dependencies (`uv` downloads a compatible Python if you don't already have one).
 * For docs/Jupyter Book work, also run `uv sync --extra dev --extra docs`.
+* Run commands in the environment with `uv run <command>`, or activate it first with `source .venv/bin/activate` (macOS/Linux) or `.\.venv\Scripts\Activate.ps1` (Windows).
 
 ### Run an example of the model
 
-* Navigate to `./examples`.
-* Run the model with an example reform: `uv run python run_og_eth.py` (or activate the venv first with `source .venv/bin/activate` on macOS/Linux or `.\.venv\Scripts\Activate.ps1` on Windows, then `python run_og_eth.py`).
+* From the repository root, run the model with an example reform: `uv run python examples/run_og_eth.py`.
 * You can adjust the `./examples/run_og_eth.py` by modifying model parameters specified in the dictionary passed to the `p.update_specifications()` calls.
 * Model outputs will be saved in the following files:
   * `./examples/OG-ETH-Example/OG-ETH_example_plots`

{ogeth-0.1.0 → ogeth-0.3.0}/README.md

@@ -11,28 +11,100 @@ OG-ETH is an overlapping-generations (OG) model that allows for dynamic general
 
 ## Using and contributing to OG-ETH
 
-There are two primary methods for installing and running OG-ETH on your computer locally. The first and simplest method is to download the most recent `ogeth` Python package from the Python Package Index ([PyPI.org](https://pypi.org/project/ogeth/)). The second option is to fork and clone the most recent version of OG-ETH from its GitHub repository and install the `ogeth` package with its development dependencies using `uv`. Both methods are detailed below.
+Install and run OG-ETH by cloning this GitHub repository and installing the `ogeth` package with its dependencies using [`uv`](https://docs.astral.sh/uv/), as detailed below. (Installing the `ogeth` package from [PyPI](https://pypi.org/project/ogeth/) with `pip` is no longer the recommended path: on the Python versions many machines ship, `pip` either refuses the current release outright — as on the Python 3.9 built into macOS — or silently pairs it with an older `ogcore` than the model is tested against, and even on a supported Python the PyPI route does not pin the `ogcore` version the repository is tested against. The `uv` workflow installs the exact tested versions of every dependency, including a compatible Python interpreter.)
 
-### Installing and Running OG-ETH from PyPI
+### Installation
 
-* On macOS, first install Xcode Command Line Tools (in Terminal: `xcode-select --install`).
-* Open your terminal and install the [`ogeth`](https://pypi.org/project/ogeth/) package from the Python Package Index by typing `pip install ogeth`.
-* Navigate to a folder `./YourFolderName/` where you want to save scripts to run OG-ETH and output from the simulations in those scripts.
-* Copy the python script [`run_og_eth.py`](https://github.com/EAPD-DRB/OG-ETH/blob/main/examples/run_og_eth.py) from the OG-ETH GitHub repository into your folder as `./YourFolderName/run_og_eth.py`.
-* Run the model with an example reform from terminal/command prompt by typing `python run_og_eth.py`.
+There are two ways to install OG-ETH: the easy way, using the OG model family's universal installer, and a manual install that runs the same steps one command at a time. Both start from a terminal, put the model in a new OG-ETH folder inside your current directory (a freshly opened terminal starts in your home folder), and need git.
 
-### Installing and Running OG-ETH from the GitHub repository
+#### Before you start: git
+
+On a Mac where you have never used git before, run this line first and accept the dialog that appears:
+
+```
+xcode-select --install
+```
+
+On Windows, install Git first (skip this if you already have it):
+
+```
+winget install --id Git.Git -e --source winget
+```
+
+#### The easy way: the universal installer
+
+The OG model family has a [universal installer](https://github.com/PSLmodels/OG-Core/blob/master/scripts/QUICK_INSTALL.md) that installs the uv tool, downloads the model, builds its environment, and verifies it — for OG-ETH or any of its sibling country models.
+
+On macOS and Linux, paste:
+
+```
+curl -fsSL https://raw.githubusercontent.com/PSLmodels/OG-Core/master/scripts/install.sh -o og-install.sh
+bash og-install.sh --repo og-eth --yes
+```
+
+On Windows (PowerShell), paste:
+
+```
+$f = "$env:TEMP\og-install.ps1"; irm https://raw.githubusercontent.com/PSLmodels/OG-Core/master/scripts/install.ps1 -OutFile $f; powershell -ExecutionPolicy Bypass -File $f -Repo og-eth -Yes
+```
+
+When the installer finishes, run the example. On macOS and Linux, paste:
+
+```
+source $HOME/.local/bin/env
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+On Windows, open a new PowerShell window (so the just-installed tools are found) and paste:
+
+```
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+#### Manual install
+
+The same setup as individual commands. On macOS and Linux, paste:
+
+```
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source $HOME/.local/bin/env
+git clone https://github.com/EAPD-DRB/OG-ETH.git
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+The second line makes the just-installed uv available in the current terminal; from your next terminal session it is available automatically.
+
+On Windows (PowerShell), install uv:
+
+```
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Then open a new PowerShell window (so the just-installed tools are found) and paste:
+
+```
+git clone https://github.com/EAPD-DRB/OG-ETH.git
+cd OG-ETH
+uv run python examples/run_og_eth.py
+```
+
+#### What happens
+
+The first `uv run` creates the project environment if it does not exist yet — downloading a compatible Python interpreter if needed and installing the exact locked dependencies — and then runs the example. Early in the run you may be asked for a UN API token; just press return, and the model reads the same population data from a public mirror and continues. A full baseline-plus-reform run takes from 35 minutes to more than two hours; when it finishes, its plots and tables are saved under `./examples/OG-ETH-Example/` (see the list of outputs below).
+
+### Installing for development or contributing
 
-* On macOS, first install Xcode Command Line Tools (in Terminal: `xcode-select --install`).
-* 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`).
 * Fork this repository and clone your fork to a directory on your computer.
-* From the terminal, navigate to the cloned directory and run `uv sync --extra dev` to create a local `.venv` and install OG-ETH with its development dependencies. `uv` will also download a compatible Python interpreter if you don't already have one.
+* From the terminal, navigate to the cloned directory and run `uv sync --extra dev` to create a local `.venv` and install OG-ETH with its development dependencies (`uv` downloads a compatible Python if you don't already have one).
 * For docs/Jupyter Book work, also run `uv sync --extra dev --extra docs`.
+* Run commands in the environment with `uv run <command>`, or activate it first with `source .venv/bin/activate` (macOS/Linux) or `.\.venv\Scripts\Activate.ps1` (Windows).
 
 ### Run an example of the model
 
-* Navigate to `./examples`.
-* Run the model with an example reform: `uv run python run_og_eth.py` (or activate the venv first with `source .venv/bin/activate` on macOS/Linux or `.\.venv\Scripts\Activate.ps1` on Windows, then `python run_og_eth.py`).
+* From the repository root, run the model with an example reform: `uv run python examples/run_og_eth.py`.
 * You can adjust the `./examples/run_og_eth.py` by modifying model parameters specified in the dictionary passed to the `p.update_specifications()` calls.
 * Model outputs will be saved in the following files:
   * `./examples/OG-ETH-Example/OG-ETH_example_plots`

{ogeth-0.1.0 → ogeth-0.3.0}/ogeth/__init__.py

@@ -8,4 +8,4 @@ from ogeth.input_output import *  # noqa: F403
 from ogeth.macro_params import *  # noqa: F403
 from ogeth.utils import *  # noqa: F403
 
-__version__ = "0.1.0"
+__version__ = "0.3.0"