Skip to content

Commit 68e4d3a

Browse files
Merge pull request #44 from ISISComputingGroup/first_time_install_uv_mention
Add uv link to first time install guide
2 parents 8acbee9 + 2944861 commit 68e4d3a

File tree

4 files changed

+22
-3
lines changed

4 files changed

+22
-3
lines changed

doc/Glossary.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,10 @@ A graphical representation of an ISIS beamline, showing permanent components as
265265

266266
## User Values
267267

268+
## uv
269+
270+
See {ref}`uv`
271+
268272
## Vagrant
269273

270274
A tool for building and managing [virtual machine](#virtual-machine) environments. See [homepage](https://www.vagrantup.com) for more information.

doc/overview/First-Time-Build.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ To easily add `EPICSTerm.bat` to the start menu after copying EPICS, run `C:\Ins
6161

6262
See [Building and installing the uktena python distribution](/system_components/python/Building-and-installing-uktena)
6363

64+
## uv
65+
66+
See {ref}`installing_uv`
67+
6468
## Ruff git hook and convenience scripts
6569

6670
In order to use this please clone the reusable workflows repo into dev

doc/scripting/uv.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
{#uv}
12
# `uv` and python environments
23

3-
`uv` is a Python package and project manager. See [`uv`'s docs](https://docs.astral.sh/uv/) for more information.
4+
[`uv`](https://github.com/astral-sh/uv) is a Python package and project manager. See [`uv`'s docs](https://docs.astral.sh/uv/) for more information.
45

56
We are currently considering whether we could use it to split up our python processes and use it for python version management on instrument machines.
67

@@ -10,7 +11,15 @@ We are currently considering whether we could use it to split up our python proc
1011
- `c:\Instrument\apps\uv\snakes` is the location of individually-versioned python interpreter executables. These are "bare" interpreters, that do not contain any dependencies such as `genie_python`.
1112
- `c:\Instrument\var\tmp\uvcache` is the location of `uv`'s pip download cache. This can safely be deleted and will be recreated as-needed.
1213

13-
## Details of `uv` setup
14+
{#installing_uv}
15+
## Installing `uv`
16+
We have a script which is used in various places to install `uv`. This will install `uv` into `c:\Instrument\apps\uv\` and can be run on instruments, build machines and developer machines.
17+
18+
To install `uv` run `\\isis\shares\ISIS_Experiment_Controls_Public\ibex_utils\installation_and_upgrade\install_or_update_uv.bat`
19+
20+
For developer machines currently this can be used for things that aren't in `\Instrument\Apps\EPICS\` such as projects you have in `Instrument\dev\` or for manually running the items below.
21+
22+
## Usage of `uv` in IBEX
1423

1524
### IBEX install scripts
1625

@@ -30,4 +39,5 @@ It can be used on Github actions CI, but isn't currently.
3039

3140
In the future we may consider using `uv` to create and build virtual environments for each respective python process that runs on the NDX. This requires some decisions and subsequent work:
3241
- `uv.lock` files - should we keep them in source, or at least on the build server, then build virtual environments on the NDXes with those specific versions?
33-
- python wheels need to be available for everything we use - the NDXes do not have compilers ie. Visual Studio installed.
42+
- python wheels need to be available for everything we use - the NDXes do not have compilers ie. Visual Studio installed.
43+

doc/spelling_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -895,6 +895,7 @@ url
895895
userdef
896896
usr
897897
utils
898+
uv
898899
uzhex
899900
vala
900901
validator

0 commit comments

Comments
 (0)