Skip to content

Commit 7566af3

Browse files
committed
Add uv link to first time install guide
1 parent 2620b91 commit 7566af3

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

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: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,15 @@ We are currently considering whether we could use it to split up our python proc
1010
- `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`.
1111
- `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.
1212

13-
## Details of `uv` setup
13+
{#installing_uv}
14+
## Installing `uv`
15+
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.
16+
17+
To install `uv` run `\\isis\shares\ISIS_Experiment_Controls_Public\ibex_utils\installation_and_upgrade\install_or_update_uv.bat`
18+
19+
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.
20+
21+
## Usage of `uv` in IBEX
1422

1523
### IBEX install scripts
1624

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

3139
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:
3240
- `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.
41+
- python wheels need to be available for everything we use - the NDXes do not have compilers ie. Visual Studio installed.
42+

0 commit comments

Comments
 (0)