Documentation

[stroblme]

This PR should resolve #36:

• update README (visualization, getting started)
• update CONTRIBUTING (documentation,..)
• check docstrings

[stroblme]

When doing a fresh install and running kedro viz, I'm getting an import error in qallse that trackml.score_event is not available. @majafranz, could you verify that?

[majafranz]

When doing a fresh install and running kedro viz, I'm getting an import error in qallse that trackml.score_event is not available. @majafranz, could you verify that?

I think we (or actually qallse) still need the trackml dependency. As it is not released on Pypi, we could try to install it via the GitHub Repo, either in this repo, or in our fork of qallse.

[stroblme]

thanks! I would prefer the second option. As we already have a fork, and qallse is tightly bound to trackml, I feel like this would be the cleanest solution

[stroblme]

resolved, I just started a transfer to your repo @majafranz ; maybe you could in turn then transfer it to lfd, then we have all in one place :)

[majafranz]

resolved, I just started a transfer to your repo @majafranz ; maybe you could in turn then transfer it to lfd, then we have all in one place :)

Thanks! This should work now, after updating the submodules.

[majafranz]

Thank you so much! 🚀