Skip to content

Commit 4cbcd3a

Browse files
authored
readme: update content
1 parent 56fe46a commit 4cbcd3a

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,49 @@
11
EigenPy — Python bindings between Numpy and Eigen
22
======
33

4-
[![License](https://img.shields.io/badge/License-BSD%202--Clause-green.svg)](https://opensource.org/licenses/BSD-2-Clause)
5-
[![Build Status](https://travis-ci.org/stack-of-tasks/eigenpy.svg?branch=devel)](https://travis-ci.org/stack-of-tasks/eigenpy)
6-
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/eigenpy.svg)](https://anaconda.org/conda-forge/eigenpy)
7-
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/eigenpy.svg)](https://anaconda.org/conda-forge/eigenpy)
8-
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/eigenpy/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)
9-
4+
<p align="center">
5+
<a href="https://opensource.org/licenses/BSD-2-Clause"><img src="https://img.shields.io/badge/License-BSD%202--Clause-green.svg" alt="License"/></a>
6+
<a href="https://travis-ci.org/stack-of-tasks/eigenpy"><img src="https://travis-ci.org/stack-of-tasks/eigenpy.svg?branch=master" alt="Build Status"/></a>
7+
<a href="https://anaconda.org/conda-forge/eigenpy"><img src="https://img.shields.io/conda/dn/conda-forge/eigenpy.svg" alt="Conda Downloads"/></a>
8+
<a href="https://anaconda.org/conda-forge/eigenpy"><img src="https://img.shields.io/conda/vn/conda-forge/eigenpy.svg" alt="Conda Version"/></a>
9+
<a href="https://conda.anaconda.org/conda-forge"><img src="https://anaconda.org/conda-forge/eigenpy/badges/installer/conda.svg" alt="Anaconda-Server Badge"/></a>
10+
</p>
1011

1112
**EigenPy** is an open source framework which allows to bind the famous [Eigen](http://eigen.tuxfamily.org) in Python as NumPy object (as matrix or array).
13+
**EigenPy** allows the sharing of memory between Numpy and Eigen avoiding memory allocation.
14+
**EigenPy** fully support Eigen::Ref avoiding memory allocation.
1215
**EigenPy** also exposes the Geometry module of Eigen for easy code prototyping.
1316
**EigenPy** also supports the basic matrix decomposion routines of Eigen such as the Cholesky decomposition, SVD decomposition, QR decomposition, and etc.
1417

1518
## Setup
1619

1720
The installation of **EigenPy** on your computer is made easy for Linux/BSD and Mac OS X environments.
1821

22+
### The Conda approach
23+
24+
You simply need this simple line:
25+
```
26+
conda install eigenpy -c conda-forge
27+
```
1928
### Ubuntu
2029

2130
You can easily install **EigenPy** from binairies.
2231

2332
#### Add robotpkg apt repository
24-
25-
1. Check your distribution codename in a terminal with the following command:
26-
```
27-
$ lsb_release -c
28-
Codename: xenial
29-
```
30-
2. Add robotpkg as source repository to apt:
33+
1. Add robotpkg as source repository to apt:
3134
```
32-
sudo sh -c "echo 'deb [arch=amd64] http://robotpkg.openrobots.org/packages/debian/pub xenial robotpkg' >> /etc/apt/sources.list.d/robotpkg.list"
35+
sudo sh -c "echo 'deb [arch=amd64] http://robotpkg.openrobots.org/packages/debian/pub $(lsb_release -cs) robotpkg' >> /etc/apt/sources.list.d/robotpkg.list"
3336
```
34-
3. Register the authentication certificate of robotpkg:
37+
2. Register the authentication certificate of robotpkg:
3538
```
3639
curl http://robotpkg.openrobots.org/packages/debian/robotpkg.key | sudo apt-key add -
3740
```
38-
4. You need to run at least once apt update to fetch the package descriptions:
41+
3. You need to run at least once apt update to fetch the package descriptions:
3942
```
4043
sudo apt-get update
4144
```
4245
#### Install EigenPy
43-
5. The installation of **EigenPy** and its dependencies is made through the line:
46+
4. The installation of **EigenPy** and its dependencies is made through the line:
4447

4548
For Python 2.7
4649
```
@@ -60,15 +63,14 @@ You just need to register the tap of the sofware repository.
6063
```
6164
brew tap gepetto/homebrew-gepetto
6265
```
63-
and then install **EigenPy** with:
66+
and then install **EigenPy** for Python 3.x with:
6467
```
6568
brew install eigenpy
6669
```
67-
for Python 2.7 or:
70+
or for Python 2.7:
6871
```
69-
brew install eigenpy-python3
72+
brew install eigenpy@2
7073
```
71-
for Python 3 support.
7274

7375
## Credits
7476

0 commit comments

Comments
 (0)