Skip to content

Commit f58aa2c

Browse files
committed
readme: Add Pixi instruction
1 parent fb92f66 commit f58aa2c

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ EigenPy — Versatile and efficient Python bindings between Numpy and Eigen
2525
- extended API to expose several STL types and some of their Boost equivalents: `optional` types, `std::pair`, maps, variants...
2626
- full support of vectorization between C++ and Python (all the hold objects are properly aligned in memory)
2727

28-
## Setup
28+
## Installation
2929

3030
The installation of **EigenPy** on your computer is made easy for Linux/BSD, Mac OS X, and Windows environments.
3131

@@ -79,6 +79,23 @@ brew install eigenpy
7979

8080
Standard matrix decomposion routines of Eigen such as the SVD and QR decompositions can be readily added to **EigenPy** following the example of the Cholesky decomposition that is already implemented. Feel free to open a PR if you wrap them for your use case.
8181

82+
## Build/install from source with Pixi
83+
84+
To build **EigenPy** from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation).
85+
86+
[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that
87+
will install all required dependencies in `.pixi` directory.
88+
It's used by our CI agent so you have the guarantee to get the right dependencies.
89+
90+
Run the following command to install dependencies, configure, build and test the project:
91+
92+
```bash
93+
pixi run test
94+
```
95+
96+
The project will be built in the `build` directory.
97+
You can run `pixi shell` and build the project with `cmake` and `ninja` manually.
98+
8299
## Credits
83100

84101
The following people have been involved in the development of **EigenPy**:

0 commit comments

Comments
 (0)