-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
64 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
*~ | ||
*build* | ||
*build*/ | ||
# pixi environments | ||
.pixi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Build and install from source with Pixi | ||
|
||
To build **EigenPy** from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation). | ||
|
||
[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that | ||
will install all required dependencies in `.pixi` directory. | ||
It's used by our CI agent so you have the guarantee to get the right dependencies. | ||
|
||
Run the following command to install dependencies, configure, build and test the project: | ||
|
||
```bash | ||
pixi run test | ||
``` | ||
|
||
The project will be built in the `build` directory. | ||
You can run `pixi shell` and build the project with `cmake` and `ninja` manually. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Contributing | ||
|
||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Release with Pixi | ||
|
||
To create a release with Pixi run the following commands on the **devel** branch: | ||
|
||
```bash | ||
EIGENPY_VERSION=X.Y.Z pixi run release_new_version | ||
git push origin | ||
git push origin vX.Y.Z | ||
git push origin devel:master | ||
``` | ||
|
||
Where `X.Y.Z` is the new version. | ||
Be careful to follow the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) rules. | ||
|
||
You will find the following assets: | ||
- `./build_new_version/eigenpy-X.Y.Z.tar.gz` | ||
- `./build_new_version/eigenpy-X.Y.Z.tar.gz.sig` | ||
|
||
Then, create a new release on [GitHub](https://github.com/stack-of-tasks/eigenpy/releases/new) with: | ||
|
||
* Tag: vX.Y.Z | ||
* Title: EigenPy X.Y.Z | ||
* Body: | ||
``` | ||
## What's Changed | ||
CHANGELOG CONTENT | ||
**Full Changelog**: https://github.com/stack-of-tasks/eigenpy/compare/vXX.YY.ZZ...vX.Y.Z | ||
``` | ||
|
||
Where `XX.YY.ZZ` is the last release version. | ||
|
||
Then upload `eigenpy-X.Y.Z.tar.gz` and `eigenpy-X.Y.Z.tar.gz.sig` and publish the release. |