Update installation instructions to the uv workflow#13
Open
marcelolafleur wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This brings the installation docs in line with what actually works, following the pattern of EAPD-DRB/OG-PHL#79.
What a user runs into today:
pip install ogbra, but theogbrapackage has never been published to PyPI, so that command fails for everyone (verified: "No matching distribution found for ogbra", tried on Python 3.9.6 and confirmed against the PyPI index). The PyPI badges in the header point at the same nonexistent package.environment.ymlwas deleted in the 0.1.0 uv migration (Migrate from conda to uv #5), soconda env createfails outright. It also tells people to run a test suite with OG-USA's markers (needs_puf,regression, "close to 24 hours") that don't exist here, and to sync with amasterbranch this repo doesn't have.What this PR does:
--repo og-bra) as the easy way, and a manual uv install — written so a novice can copy-paste each block, with separate macOS, Linux, and Windows instructions, prerequisites included, and a note on what to expect from the example run (runtime, output locations, and that the UN data token prompt can be answered by just pressing return).uv sync --extra dev; the test command is the repo's real one (uv run python -m pytest -m "not local");masterreferences are nowmain.What was tested: from a fresh clone of this repo, the manual path (
uv sync --extra dev, import, fast test files — 11 passed) works end to end on macOS; the universal-installer path was run end to end against this repo and completes in about half a minute. Lint is green. No changes touv.lockor any code.One dependency: the
--repo og-brashortcut in the README needs the installer catalog entry in PSLmodels/OG-Core#1179 to merge first. Until then the installer path works via--repo-url https://github.com/PSLmodels/OG-BRA.git.