Skip to content

Commit 87f979a

Browse files
committed
doc: install-locked-env
1 parent 1ebfdf7 commit 87f979a

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ pip install fluidsim
3232
There are also conda packages in the conda-forge channel usable with
3333
[Pixi](https://pixi.sh) or [conda/mamba](https://github.com/conda-forge/miniforge).
3434

35+
The simplest way to get a production environment using the conda-forge packages is with
36+
37+
```sh
38+
uvx install-locked-env https://github.com/fluiddyn/fluidsim/tree/branch/default/pixi-envs/env-fluidsim-mpi
39+
```
40+
3541
Much more detailed instructions are given in
3642
[the documentation](https://fluidsim.readthedocs.io/en/latest/install.html).
3743

doc/install.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,22 @@ environments in the Fluidsim repository
100100
- `env-fluidsim-mpi` is for running sequential and parallel (MPI) simulations and
101101
post-process results. It is only available on Linux.
102102

103-
First, get one of these directories locally on your computer (the easiest is to clone the
104-
Mercurial repo <https://foss.heptapod.net/fluiddyn/fluidsim> or the Git mirror
105-
<https://github.com/fluiddyn/fluidsim/>). To install and to use one of these
106-
environments, enter into the directory and run `pixi shell`.
103+
The simplest solution to install one of these environment locally is to use `uv` and the
104+
tool `install-locked-env` like this:
105+
106+
```sh
107+
cd where/you/want/to/have/the/pixi/env/directory
108+
uvx install-locked-env https://github.com/fluiddyn/fluidsim/tree/branch/default/pixi-envs/env-fluidsim
109+
```
110+
111+
To use one of these environments, enter into the directory and run `pixi shell`.
112+
113+
```{admonition} Alternative method without install-locked-env
114+
Alternatively, one needs to get these directories locally on your computer
115+
(for example by cloning the Mercurial repo
116+
<https://foss.heptapod.net/fluiddyn/fluidsim> or the Git mirror
117+
<https://github.com/fluiddyn/fluidsim/>) and run `pixi shell`.
118+
```
107119

108120
````{admonition} How to activate such environment in shell scripts?
109121
@@ -115,6 +127,8 @@ eval "$(pixi shell-hook --manifest-path ~/dev/fluidsim/pixi-envs/env-fluidsim-mp
115127

116128
````{admonition} How to register a Jupyter kernel using this environment
117129
130+
(This step should already have been done if you used `install-locked-env`.)
131+
118132
```sh
119133
pixi shell --manifest-path ~/dev/fluidsim/pixi-envs/env-fluidsim-mpi
120134
python -m ipykernel install --user --name=env-fluidsim-mpi

0 commit comments

Comments
 (0)