-
Notifications
You must be signed in to change notification settings - Fork 118
Expand UV installation and usage instructions #1007
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR reorganizes and expands the UV Package and Project Manager installation documentation for ActivitySim. The documentation is restructured to provide clearer guidance on installation options and includes more detailed instructions for Windows users.
- Reorganized UV installation section with clearer subsections and step-by-step instructions
- Added detailed Windows-specific UV installation instructions with PowerShell commands
- Expanded Option 1 (From PyPI) and Option 2 (From Source with Lockfile) with more context and clarification
- Added new Common Q&A section to address frequently asked questions about UV usage
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Do we want to consider recommending locking uv on a script file for model application use? An example is here. I'm not sure if this is easier or harder for an agency application. |
|
@jpn-- my understanding is that |
| copy path\to\shared\uv.lock . | ||
|
|
||
| # Recreate the same environment | ||
| uv sync --locked |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest we add an additional Question here: "Can other users on the same server or machine use my already created virtual environment?"
My understanding is the answer is: "No. When UV installs the dependencies, paths are created specific to the user. As such, if another user tries to activate your virtual environment, that environment will not work for them."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The answer is Yes, but it requires admin rights and additional setup. I added it to the Q&A and provided some instructions. SANDAG was able to do this. I haven't tested it myself because I do not have admin rights on WSP machines. I think we should advise "This is doable but we do not recommend it. We recommend sharing the lockfile and uv sync"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think what @i-am-sijia wrote in this version of the docs is fine. If I were writing it I'd write it in an even more strongly worded manner; an ideal use case is a fully containerized environment where ActivitySim runs in a way where no other user and no other process can interfere with it.
This pull request substantially revises and expands the documentation for installing and setting up ActivitySim using the UV package and project manager. The changes clarify recommended installation methods for different user types, provide detailed step-by-step instructions for installing UV and ActivitySim (both from PyPI and from source with a lockfile), and introduce a comprehensive Q&A section to address common user scenarios and troubleshooting.
Expanded and Detailed UV Installation Instructions
Comprehensive ActivitySim Installation Options Guidance and User Recommendations
New Q&A Section for Common User Scenarios
uv run.