oysstu / pyimc

Python bindings for Inter-Module Communication Protocol (IMC)
Other
9 stars 6 forks source link

Document the library #5

Open oysstu opened 5 years ago

oysstu commented 5 years ago

No documentation currently exists for the library, only a few examples. Create generated documentation online using e.g. readthedocs.io.

Users are assumed to familiarize themselves with the IMC specification and how to use that in relation to systems running DUNE. This documentation would strictly be related to the implemented actors, node map, decorators, lsf parsing, and exposed DUNE functionality