Skip to content

Commit dfeda72

Browse files
committed
Update doc/build-from-source.md
1 parent c17e2f2 commit dfeda72

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

doc/build-from-source.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -177,15 +177,15 @@ Note that Fluidimage builds are not sensible to the [`~/.pythranrc` file](pythra
177177

178178
Let us first present the tools used for Fluidimage development.
179179

180-
- [PDM] is a modern Python package and dependency manager,
180+
- [pip] is the official package installer for Python,
181181

182-
- [Meson] is an open source build system (in particular used by Scipy),
182+
- [PDM] is a modern Python package and dependency manager,
183183

184184
- [Nox] is a command-line tool that automates testing in multiple Python environments,
185185

186-
- [Pytest] is the most popular testing framework for Python,
186+
- [Meson] is an open source build system (in particular used by Scipy),
187187

188-
- [pip] is the official package installer for Python,
188+
- [Pytest] is the most popular testing framework for Python,
189189

190190
- [Pythran] is an ahead of time compiler for a subset of the Python language, with a
191191
focus on scientific computing,
@@ -197,6 +197,11 @@ Fluidimage is built with [Meson]. We use [PDM] for Fluidimage development. [Pyte
197197
[Nox] are used for testing. We use [Pythran] through [Transonic] to accelerate some
198198
numerical kernels written in Python.
199199

200+
```{note}
201+
Most dependencies (Meson, Pytest, Pythran, Transonic, ...) will be installed by PDM.
202+
The developers just have to install manually PDM (and potentially Nox).
203+
```
204+
200205
#### Standard Python from Python.org
201206

202207
We present here how one can build Fluidimage from source like the main developers and
@@ -217,8 +222,13 @@ Installing in editable mode is a bit particular with Meson, since editable insta
217222
are incompatible with isolated builds, meaning that all build dependencies have to be
218223
installed in the main virtual environment! Fortunatelly, it's simple with [PDM].
219224

225+
##### Build-install Fluidimage with pdm
226+
220227
```{warning}
221228
You should not run the following commands from a virtual environment not related to Fluidimage.
229+
230+
No need to manually create a dedicated environment since PDM is going to do it for you.
231+
Just deactivate all Python environments.
222232
```
223233

224234
From the root directory of the repository, just run:

0 commit comments

Comments
 (0)