Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
Signed-off-by: soblin <[email protected]>
  • Loading branch information
soblin committed Oct 22, 2022
1 parent 85ba09b commit b49de37
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ descibed in [minimal example](#minimal-example).

## Syntax

The user will need to capsulate *arguments* in `Args(arg1, arg2, ...) == pybind11:tuple` and *keyword arguments* in `Kwargs("k1"_a = v1, "k2"_a = v2, ...) == pybind11::dict`. The returned value is either a `pybind11::object` or a corresponding wrapper class. Please refer to the reference and examples below.
The user will need to capsulate *arguments* in `Args(arg1, arg2, ...) == pybind11:tuple` and *keyword arguments* in `Kwargs("k1"_a = v1, "k2"_a = v2, ...) == pybind11::dict`. The returned value is a wrapper class for pybind. Please refer to the reference and examples below.
- exception: `subplots`, `TBD`s
- conversion: Wrapper class of matplotlibcpp17 like [::container::BarContainer](https://github.com/soblin/matplotlibcpp17/blob/master/include/matplotlibcpp17/container.h) needs to be passed to python interpreter using `unwrap()` method in *args* and *kwargs*.

Expand Down Expand Up @@ -180,6 +180,16 @@ From [gallery/images_contours_and_fields/quiver_demo.cpp](https://github.com/sob

![quiver_demo3](./gallery/images/quiver_demo_3.png)

### 3D

To plot 3D graph with `projection = "3d"`, following code is required.

```cpp
#include <matplotlibcpp17/mplot3d.h>

matplotlibcpp17::mplot3d::import();
```

### gif

Currently only `ArtistAnimation` is supported. `FuncAnimation` interface maybe implemented in the future.
Expand Down
1 change: 1 addition & 0 deletions include/matplotlibcpp17/cm.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

namespace matplotlibcpp17::cm {

// TODO: more colors
static const char *coolwarm = "coolwarm";
static const char *PuBu_r = "PuBu_r";
static const char *RdYlGn = "RdYlGn";
Expand Down

0 comments on commit b49de37

Please sign in to comment.