BiocomputeLab / paraSBOLv

A lightweight Python library designed to simplify the development of tools that render SBOL Visual diagrams.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tutorial and user guide

chofski opened this issue · comments

It would be useful to have a tutorial on how to use the core functions of the library and also a description of how to create new pSVG files.

These should be extended to each of the core tools we develop (e.g. sbolv-cli)

On Friday I wrote a 'getting started' module on the basics that should automatically be incorporated into the docs - maybe a pSVG file creation section could be appended to that?

I'll take a look. Where is it?

getting_started.py in the main parasbolv directory. I made it a ''module'' so that it gets automatically included at the front of the documentation (it's currently live on the docs) but it can be moved if needed.

I'll move it to a separate markdown document. Prefer to keep code, code.

I've cleaned up the tutorial @cclark1e. I think it is nearly there. Is there anything you can see that is missing. I was thinking it might be good to also include the basic drawing of interactions, without a construct as this is core basic functionality you'd need to know if building a tool. Developers are unlikely to use the Construct object but instead write there own customised for their needs.

P.S. all these are in the tutorials folder.

These have been updated and are ready for an initial release.