Skip to content

Commit 6010a33

Browse files
committed
UV installation documentation: update URL, fix indentation
1 parent ffd7154 commit 6010a33

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

docs/running.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -52,81 +52,81 @@ To install UV and create asim_140 environment using UV for all users on a server
5252

5353
- Create the following directories
5454

55-
- C:\uv_env
55+
- C:\uv_env
5656

57-
- C:\uv_env\uv_py
57+
- C:\uv_env\uv_py
5858

5959
- Open Power Shell (normal user, no admin)
6060

6161
- cd into C:\uv_env
6262

6363
- Run the following command
6464

65-
`powershell -ExecutionPolicy ByPass -c {$env:UV_INSTALL_DIR = "C:\uv_env";irm https://astral.sh/uv/install.ps1 | iex} `
65+
`powershell -ExecutionPolicy ByPass -c {$env:UV_INSTALL_DIR = "C:\uv_env";irm https://github.com/astral-sh/uv/releases/latest/download/uv-installer.ps1 | iex}`
6666

6767
- Close Power Shell
6868

6969
- Under Environment Variables > System variables (requires Admin)
7070

71-
- Add **C:\uv_env** to ***Path***
71+
- Add **C:\uv_env** to ***Path***
7272

73-
- Create new variable called ***UV_PYTHON_INSTALL_DIR*** and set to **C:\uv_env\uv_py**
73+
- Create new variable called ***UV_PYTHON_INSTALL_DIR*** and set to **C:\uv_env\uv_py**
7474

7575
- Open Command Prompt (normal user, no admin)
7676

7777
- Run the following command
7878

79-
`uv python install 3.10`
79+
`uv python install 3.10`
8080

8181
- Under Environment Variables > System variables (requires Admin)
8282

83-
- Create new variable called ***UV_PYTHON*** and set to path of python.exe from previous step’s installation
83+
- Create new variable called ***UV_PYTHON*** and set to path of python.exe from previous step’s installation
8484

85-
- Hint: in command prompt, run the following command for the exact path:
85+
- Hint: in command prompt, run the following command for the exact path:
8686

87-
`uv python find`
87+
`uv python find`
8888

89-
- e.g., *C:\uv_env\uv_py\cpython-3.10.18-windows-x86_64-none\python.exe*
89+
- e.g., *C:\uv_env\uv_py\cpython-3.10.18-windows-x86_64-none\python.exe*
9090

9191
- In command prompt, cd into C:\uv_env
9292

9393
- Run the following commands (one at a time):
9494

95-
`mkdir asim_140 `
95+
`mkdir asim_140 `
9696

97-
`cd asim_140 `
97+
`cd asim_140 `
9898

99-
`echo 3.10 > .python-version `
99+
`echo 3.10 > .python-version `
100100

101-
`uv init `
101+
`uv init `
102102

103103
- Open asim_140/pyproject.toml and edit the requires-python setting to:
104104

105-
- requires-python = ">=3.10, <3.11"
105+
- requires-python = ">=3.10, <3.11"
106106

107107
- Back in command prompt (at C:\uv_env\asim_140), run one final command
108108

109-
`uv add -r requirements.txt `
109+
`uv add -r requirements.txt `
110110

111-
- The requirements.txt will have to be saved under asim_140 or you will have to point to wherever it is saved
111+
- The requirements.txt will have to be saved under asim_140 or you will have to point to wherever it is saved
112112

113-
- The requirements.txt is on the GitHub repo at: [requirements.txt](https://github.com/SANDAG/ABM/blob/main/src/asim/scripts/requirements.txt)
113+
- The requirements.txt is on the GitHub repo at: [requirements.txt](https://github.com/SANDAG/ABM/blob/main/src/asim/scripts/requirements.txt)
114114

115-
- The requirements.txt can also be found on T at: "T:\ABM\dev\ABM3\src\asim\scripts\requirements.txt"
115+
- The requirements.txt can also be found on T at: "T:\ABM\dev\ABM3\src\asim\scripts\requirements.txt"
116116

117-
- Ensure it is the latest
117+
- Ensure it is the latest
118118

119119
- Open command prompt as admin and run the following command:
120120

121-
`icacls C:\uv_env /reset /T `
121+
`icacls C:\uv_env /reset /T `
122122

123-
- In testing, we found that every time a package is added to a UV environment, the package files will not have permission for all users so the reset from above needs to be executed
123+
- In testing, we found that every time a package is added to a UV environment, the package files will not have permission for all users so the reset from above needs to be executed
124124

125125
- Under Environment Variables > System variables (requires Admin)
126126

127-
- Create a new variable called ***activate_uv_asim*** and set to the path of asim_140’s activate file
127+
- Create a new variable called ***activate_uv_asim*** and set to the path of asim_140’s activate file
128128

129-
- E.g., C:\uv_env\asim_140\.venv\Scripts\activate
129+
- E.g., C:\uv_env\asim_140\\.venv\Scripts\activate
130130

131131
#### Azure Environment Variables
132132

0 commit comments

Comments
 (0)