Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial on working with SBOL Data Model #449

Merged
merged 4 commits into from
Apr 8, 2024

Conversation

PiotrZakrzewski
Copy link
Contributor

Based on https://github.com/SynBioDex/SBOL-Notebooks/blob/main/iwbda_2023_examples.ipynb

The intention is to provide a set of concrete examples on how to create and modify different SBOL data structures.

@PiotrZakrzewski
Copy link
Contributor Author

@jakebeal Could you help me with this draft? Are there any stylistic conventions I should adapt to? What content do you think this tutorial should have at the minimum?

@jakebeal
Copy link
Contributor

If you're willing, it would be great to start by just mapping the whole thing over, as is. The style that you've got is looking good in the test build: https://pysbol3--449.org.readthedocs.build/en/449/sbol_data_model.html

With regards to the Range content that you are contributing, it would be nice to have it be actually executable in combination with the rest of the code in the document. For example, you might use the Range to make a SequenceFeature in e0040 that marks the start codon of its e0040_sequence

Finally: don't worry about the build error that's there right now -- that is a different issue that showed up on the main branch too, due to a chance in pylint standards, and I've just filed issue #450 for dealing with that.

@PiotrZakrzewski PiotrZakrzewski force-pushed the piotr/range-usage-docs branch from 39c2d4e to 4cc98e3 Compare March 21, 2024 13:39
@PiotrZakrzewski
Copy link
Contributor Author

@jakebeal I pushed the draft of mapping the Jupyter tutorial as-is, without the Range part. Once this is merged I will make another PR just for the Range part.

I will fix some small formatting issues and proof read the draft tomorrow before I remove the Draft label, but feel free to leave some remarks already.

@PiotrZakrzewski PiotrZakrzewski force-pushed the piotr/range-usage-docs branch from 4cc98e3 to 9f9e41a Compare March 22, 2024 10:25
@PiotrZakrzewski PiotrZakrzewski marked this pull request as ready for review March 22, 2024 10:27
@PiotrZakrzewski
Copy link
Contributor Author

@jakebeal ready

@tcmitchell
Copy link
Collaborator

@PiotrZakrzewski thank you, this looks great to me. @jakebeal will need to review it as well. Thanks very much for the contribution!

@tcmitchell tcmitchell added this to the 1.2 milestone Mar 22, 2024
@tcmitchell
Copy link
Collaborator

@jakebeal it would be nice to have you review the document before merging. If you think it's fine without review please add a comment and I'll go ahead and merge. Thanks!

Copy link
Contributor

@jakebeal jakebeal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the delay in review. I have finally had a chance to go carefully end-to-end. I found a couple of typos, but other than that it looks goof to go!

docs/sbol_data_model.rst Outdated Show resolved Hide resolved
docs/sbol_data_model.rst Outdated Show resolved Hide resolved
@jakebeal jakebeal merged commit 9c86b3e into SynBioDex:main Apr 8, 2024
12 checks passed
@PiotrZakrzewski PiotrZakrzewski deleted the piotr/range-usage-docs branch April 18, 2024 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants