Minimal Examples and Documentation

[kougioulis]

Hi CausalFlow/CAnDOIT team,

First, thanks a lot for sharing this work, it's really appreciated.

I ran into some issues trying to get the minimal examples running. They seem to throw errors (probably because they refer to an earlier version of the codebase?). Also, the documentation is very limited — there appear to be missing imports in the code snippets of the docs and isn't really clear how some of them differ from Tigramite aren't very clear without digging deep into the source code trying to get things running properly. The RandomGraph examples run correctly btw.

I eventually got it working, but it took quite a bit of source code reading. It would really help others get started more easily with the algorithms if a minimal running example would be included and some more extensive documentation like in Tigramite (or up to a certain point, I understand that Tigramite is much more mature).

Thanks again, Nikolas 🫶