Expand UV installation and usage instructions by i-am-sijia · Pull Request #1007 · ActivitySim/activitysim

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

i-am-sijia · 2025-10-28T22:53:18Z

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.

Copilot

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-- · 2025-11-03T04:47:22Z

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.

i-am-sijia · 2025-11-06T16:33:51Z

@jpn-- my understanding is that uv lock --script one_single_script.py is a minimal set up, is fast, but is limited to single scripts (what happens if agencies have multiple scripts?). Is there any additional benefit compared to just setting up a UV project/environment in the normal way? The locking process is not fundamentally different than setting up a UV project/environment so I am open to be convinced either way. Some online posts suggest: "for model applications, use script locking for exploration/prototyping, transition to full project when moving to production or when complexity grows."

dhensle · 2025-11-06T18:10:31Z

+ copy path\to\shared\uv.lock .
+
+ # Recreate the same environment
+ uv sync --locked


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."

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"

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.

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Expand UV installation and usage instructions
e1d10ac

i-am-sijia linked an issue Oct 29, 2025 that may be closed by this pull request
Develop and test robust, multi-platform UV-based installation for v1.4.x and 1.5.x #995
Closed

jpn-- requested review from JoeJimFlood, Copilot, dhensle and jpn--October 30, 2025 16:09

CopilotAI reviewed Oct 30, 2025
View reviewed changes

jpn-- mentioned this pull request Oct 30, 2025
2025-10-30 Engineering Team ActivitySim/meeting-notes#40
Closed

i-am-sijia added 2 commits October 31, 2025 10:03

disable auto upgrade
77059ce

Update modelsetup.rst
171618d

jpn-- approved these changes Nov 3, 2025
View reviewed changes

jpn-- moved this to Tasked in Phase 11 Nov 6, 2025

jpn-- added this to Phase 11 Nov 6, 2025

dhensle reviewed Nov 6, 2025
View reviewed changes

address comments
acee9d4

i-am-sijia marked this pull request as ready for review November 7, 2025 21:27

jpn-- merged commit ed44a40 into ActivitySim:mainNov 11, 2025
20 of 30 checks passed

github-project-automationBot moved this from Tasked to Done in Phase 11 Nov 11, 2025

Uh oh!

Conversation

i-am-sijia commented Oct 28, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jpn-- commented Nov 3, 2025

Uh oh!

i-am-sijia commented Nov 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

i-am-sijia commented Oct 28, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jpn-- commented Nov 3, 2025

Uh oh!

i-am-sijia commented Nov 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

i-am-sijia commented Oct 28, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!