Skip to content

Commit

Permalink
Ref None
Browse files Browse the repository at this point in the history
- Updated README for capitalized Lielab.hpp include as well as Python install.
  • Loading branch information
msparapa committed Apr 29, 2024
1 parent e1a68e8 commit ec10133
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Source code and prebuilt binaries are available on various artifact hosting webs

### Python

Install lielab with pip
Install Lielab with pip

```
pip install lielab
Expand All @@ -19,7 +19,7 @@ pip install lielab
Add Lielab to another project by adding it to the conanfile.txt and include with

```
#include <lielab>
#include <Lielab.hpp>
```

Alternatively, the header files can be included directly into other projects. Eigen must be made available in this case.
Expand All @@ -36,7 +36,12 @@ cmake --preset conan-default -DLIELAB_BUILD_TESTS=False
cmake --build . --preset conan-release --target cppLielab
```

This will build the pyd file required for Python, and also skip building the pure C++ test cases.
This will build the pyd file required for Python, and also skip building the pure C++ test cases. The Python wrapper can then be installed with

```
cd python
pip install -e .
```

### CMake

Expand All @@ -55,6 +60,13 @@ cmake .. -DLIELAB_BUILD_TESTS=False
cmake --build . --target cppLielab
```

This will build the pyd file required for Python, and also skip building the pure C++ test cases. The Python wrapper can then be installed with

```
cd python
pip install -e .
```

## Dev Note

Using the Lielab Pybind11 wrapper to communicate to a heavier weight C++ code also using Lielab can be a very effective way at developing relatively performant C++ code while still retaining the usability of Python. When doing this, error messages thrown can be very unhelpful. The most common one may look like:
Expand Down

0 comments on commit ec10133

Please sign in to comment.