Skip to content

Commit

Permalink
Doc build with pixi
Browse files Browse the repository at this point in the history
  • Loading branch information
paugier committed Jan 10, 2024
1 parent 771d67e commit d8e74c1
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions doc/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,14 +214,20 @@ with:
pip install -e . -v --no-build-isolation --no-deps
```

### Python installed with conda/mamba/conda-forge
### Conda-based Python with conda-forge and Pixi

```{todo}
Experiment, find a good solution and describe it here!
One can use [Pixi] to setup a developer environment based on [conda-forge] and compile from source. From the root directory of Fluidsim repository, just
run:

```sh
# TODO: remove this clone after Transonic release
hg clone https://foss.heptapod.net/fluiddyn/transonic/ ../transonic
pixi run install-editable
pixi run fluidsim-test -v
```

Then, `pip` is available and previous commands should work.

## Advice for developers

### Run the tests
Expand Down Expand Up @@ -265,13 +271,15 @@ export MESONPY_EDITABLE_VERBOSE=1
See
https://meson-python.readthedocs.io/en/latest/how-to-guides/editable-installs.html#verbose-mode

[conda-forge]: https://conda-forge.org/
[evolve]: https://www.mercurial-scm.org/doc/evolution/
[mercurial]: https://www.mercurial-scm.org/
[meson]: https://mesonbuild.com
[nox]: https://nox.thea.codes
[pdm]: https://pdm-project.org
[pip]: https://pip.pypa.io
[pipx]: https://github.com/pypa/pipx
[pixi]: https://pixi.sh/
[pytest]: https://docs.pytest.org
[pythran]: https://pythran.readthedocs.io
[topic]: https://www.mercurial-scm.org/doc/evolution/tutorials/topic-tutorial.html
Expand Down

0 comments on commit d8e74c1

Please sign in to comment.