First Python-Wrapper Documentation #103
Conversation
Signed-off-by: Kevin Vu te Laar <[email protected]>
There was a problem hiding this comment.
I left some initial comments, but overall I think the quality of the page is not yet up to par to be included in the VILLASnode documentation.
This needs to be improved. It also focuses far to much on development internals and should be written with users in mind.
| @@ -0,0 +1,931 @@ | |||
| # Python-Wrapper Documentation: | |||
|
|
|||
| >Important Preface: | |||
There was a problem hiding this comment.
Please use a Docusaurus Admonitions.
| 6. [Installation](#6.-installation) | ||
|
|
||
| ## 1. VILLASnode functions exposed by the C-API | ||
| ``` |
There was a problem hiding this comment.
Please at the proper language to all code-blocks:
| ``` | |
| ```c |
| # Python-Wrapper Documentation: | ||
|
|
||
| >Important Preface: | ||
| All of the documentation and testing done regarding the VILLASnode Python-Wrapper |
There was a problem hiding this comment.
| All of the documentation and testing done regarding the VILLASnode Python-Wrapper | |
| All of the documentation and testing done regarding the VILLASnode Python-wrapper |
|
|
||
| >Important Preface: | ||
| All of the documentation and testing done regarding the VILLASnode Python-Wrapper | ||
| is based upon the signal_v2 node provided by VILLASnode. |
There was a problem hiding this comment.
| is based upon the signal_v2 node provided by VILLASnode. | |
| is based upon the `signal_v2` node-type provided by VILLASnode. |
| const char *node_to_json_str(vnode *n); | ||
| unsigned sample_length(vsample *smp); | ||
|
|
||
| #Functions related to data transfer |
There was a problem hiding this comment.
| #Functions related to data transfer | |
| # Functions related to data transfer |
|
|
||
| ## 1. VILLASnode functions exposed by the C-API | ||
| ``` | ||
| #Functions to set up up a node or modify its state |
There was a problem hiding this comment.
| #Functions to set up up a node or modify its state | |
| # Functions to set up up a node or modify its state |
| 5. [Contributing to the Python-Wrapper](#5.-contributing-to-the-python-wrapper) | ||
| 6. [Installation](#6.-installation) | ||
|
|
||
| ## 1. VILLASnode functions exposed by the C-API |
There was a problem hiding this comment.
Can we link to the actual header from the VILLASnode repo here?
E.g: https://github.com/VILLASframework/node/blob/master/include/villas/node.h
| 2. Build VILLASnode from source [as is described here](../installation.md) and make sure to have all of the necessary | ||
| dependencies installed. | ||
|
|
||
| **The requirements for the Python-Wrapper differ from the Versions listed in 2.** |
There was a problem hiding this comment.
| **The requirements for the Python-Wrapper differ from the Versions listed in 2.** | |
| **The requirements for the Python-Wrapper differ from the versions listed in 2.** |
| This is where Pybind11 has the advantage of being a header only library, essentially being Macros that directly use the Python C API. This gives you more direct control as for how your code works and interacts with C/C++/Python. | ||
| Especially Pybind11 being the more lightweight solution, considering dependencies, installation and integration, makes it more favorable to use. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Are the horizontal lines necessary? Its breaking consistency with other pages.
| ... | ||
| } | ||
|
|
||
| #C-API of VILLASnode called by the node_start() binding |
There was a problem hiding this comment.
| #C-API of VILLASnode called by the node_start() binding | |
| # C-API of VILLASnode called by the node_start() binding |
Changes that could and may should be made:
Integration of a Lab, if not multiple (one without and one with openDSS once it is ready) as a showcase.
Migrate some of the code examples to a Lab or remove them, if they become necessary due to the Labs.
Expand the collection of improvements/suggestions and bugs, if any more are found.
More detailed installation documentation.
Maybe provide Distro specific instructions (including package/dependency names) or installation scripts,
such as a PKGBUILD file for Arch Linux (as an example).