Streamlining the RosettaScripts Interface: RosettaScripts Type-hinting in VS Code

~ contributed by Dr. Vikram Mulligan


RosettaScripts Type-hinting in VS Code

By Dr. Vikram Mulligan, Research Scientist, Flatiron Institute


The RosettaScripts scripting language began as a loose XML-like language with informal syntax, with each Rosetta module defining its own XML interface.  This made it difficult to ensure that Rosetta could handle bad inputs correctly: often, typos or nonsensical inputs were simply ignored, and users were not alerted about problems in their scripts.  This was solved by formalizing the XML interface with an XML Schema Definition (XSD), a project led by Dr. Andrew Leaver-Fay a few years back.  We now require any Rosetta module with an XML interface to provide a machine-readable description of the XML interface, permitting automated checking of syntax, unused inputs, etc., and allowing informative error messages.


Rosetta now automatically interrogates all of its own modules on startup and constructs a unified XSD for the entire RosettaScripts language.  This turns out to be useful for other things as well.  One is easier interfaces with script editors and interactive development environments (IDEs), which can read XML schemas and use them to provide type-hinting and autocompletion.  We’ve recently added instructions on the Rosetta help wiki (https://new.rosettacommons.org/docs/latest/scripting_documentation/RosettaScripts/Using-RosettaScripts-with-VSCode) for exporting the RosettaScripts XSD from Rosetta and setting up type-hinting and autocorrect in VSCode, making it much easier to write RosettaScripts XML files.  In addition, the same XSD infrastructure has enabled the rosetta_scripts application’s “-info” command-line flag, which can be used to write a human-readable summary of the interface of any Rosetta mover, filter, task operation, simple metric, residue selector, etc.  If you would like to take it for a test drive, try running the rosetta_scripts application with the flag “-info PackRotamersMover”.



Popular posts from this blog

Announcing the winners of the Winter Protein Design Games 2024: Unleashing Innovation in Enzyme Engineering

Image
The Winter RosettaCon organizers want to thank Liberum Bio for sponsoring the experimental validation of the designs that they carried out in 8 days starting from digital sequences! Liberum Bio produces proteins at high yields in cell-free systems at a fraction of the usual cost and time via highly engineered strains and state-of-the art reaction mixtures. At Winter RosettaCon 2024 in Boston, the Rosetta Commons in partnership with Liberum Biotech hosted the inaugural Winter Protein Design Games , focusing on the design of Tobacco Etch Virus (TEV) protease variants. TEV protease is commonly used as a tool for sequence-specific protein cleavage, facilitating the purification of proteins without affinity tags. The competition challenged cross-institutional participating teams to engineer TEV proteases that exhibited enhanced substrate cleavage efficiency over the wild-type enzyme.  The competition was straightforward: design TEV protease variants that outperform the wild type in cleavi
Read more

Future of Rosetta Task Force Update

Image
By Camille Mathis The FoR Task Force would like to share this update with the Rosetta Commons community. One year ago, at the start of 2022, the Rosetta board asked our group to explore open-sourcing Rosetta in order to adapt to the changing landscape and rapid developments in our field. Over the past year, starting with presentations on open-sourcing ideas to the TeleCon group and the Board, the work evolved to focus more broadly on the Future of Rosetta. This pivot was determined to be an essential prerequisite for realistic and thoughtful conversations about open source feasibility. The efforts of the team included a proposal on the future organizational structure and fiscal sponsorship, a town hall meeting to capture community perspectives on the proposal, a vote by the Board to endorse the revised proposal, discussions at RosettaCon, and formation of committees to carry out the next stages of visioning and capacity building for our community. To reference past FoR activities, see
Read more

De novo proteins and where to find them - RosettaCon 2022

Image
By Kieran Didi There has been a lot happening recently in protein design, and it is easy to get lost in the daily flood of new papers and exciting ideas (for an overview of current models and approaches see this review which includes a great model table ). In such situations, it often helps to step back for a second, look at the bigger picture and chat to people about what is happening and what the future might hold. Luckily, RosettaCon was happening this August and provided a venue for exactly that: chat to people about protein design and fascinating ideas! In this post I want to highlight some presentations from the conference that I think are representative of some broader directions in the field.  Scaffolding protein motifs using Deep Learning - (Baker Lab, IPD, UW) While complete de novo design of proteins is still the holy grail of the field, in practice you often want to incorporate a motif  known from nature into a new custom-made scaffold. This motif-scaffolding problem
Read more