Skip to content

Conversation

@i-am-sijia
Copy link
Contributor

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

  • Added step-by-step instructions for installing UV on Windows (including user and global installs), updating PATH, and verifying installation, with links to official resources.

Comprehensive ActivitySim Installation Options Guidance and User Recommendations

  • Provided thorough instructions for installing ActivitySim using UV both from PyPI and from source with a lockfile, including explanations of the implications for dependency management and reproducibility.
  • Clarified which installation method is recommended for different users, specifying criteria such as familiarity with Python, need to customize code, and management of virtual environments.
  • Added a comparison table to help users choose between installation options based on their needs (official release, development, reproducibility, etc.).

New Q&A Section for Common User Scenarios

  • Introduced a Q&A section addressing how to add additional packages, manage conflicting dependencies, share working environments, handle dependency issues, and clarify when to activate virtual environments versus using uv run.

Copy link
Contributor

Copilot AI left a 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.

@jpn--
Copy link
Member

jpn-- commented Nov 3, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x

2 participants