Tutorials: Difference between revisions

From BCOeditor Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
<!-- BANNER ACROSS TOP OF PAGE -->
<!-- BANNER ACROSS TOP OF PAGE -->
 
<!-- BANNER ACROSS TOP OF PAGE -->
 
<div id="ggw-topbanner" style="clear:both; position:relative; box-sizing:border-box; width:100%; margin:1.2em 0 6px; min-width:47em; border:1px solid #ddd; background-color:#f9f9f9; color:#000;">
<div style="clear: both;"><br />
     <div style="margin:0.4em; text-align:center;">
        <div style="border-top: 1px solid #CCC; padding-top: 0.5em;"><div id="ggw_row3" style="display: flex; flex-flow: row wrap; justify-content: space-between; padding: 0; margin: 0 -5px 0 -5px;">
        <div style="font-size:160%; padding:.1em;">Welcome to BioCompute Tutorial,</div>
     <div style="flex: 1; margin: 5px; min-width: 210px; border: 1px solid #CCC; padding: 0 10px 10px 10px; box-shadow: 0 2px 2px rgba(0,0,0,0.1); background: #f5faff;">
         <div style="font-size:100%;">This page provides information regarding the BioCompute portal. It has several sections on different topics that will help you to navigate through most of the functions on the BioCOmpute Portal.
        <h3>Tutorial</h3>
    </div>
         <div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
This page has several sections that will help you to go through most of the functions on the BioCOmpute Portal.  
</div>
</div>
    </div>
<div style="clear: both;"></div>
</div></div></div>


<div id="ggw_row2" style="display: flex; flex-flow: row wrap; justify-content: space-between; padding: 0; margin: 0 -5px 0 -5px;">
<div id="ggw_row2" style="display: flex; flex-flow: row wrap; justify-content: space-between; padding: 0; margin: 0 -5px 0 -5px;">
Line 29: Line 26:
     </div>
     </div>
     <div style="flex: 1; margin: 5px; min-width: 210px; border: 1px solid #CCC; padding: 0 10px 10px 10px; box-shadow: 0 2px 2px rgba(0,0,0,0.1); background: #f5faff;">
     <div style="flex: 1; margin: 5px; min-width: 210px; border: 1px solid #CCC; padding: 0 10px 10px 10px; box-shadow: 0 2px 2px rgba(0,0,0,0.1); background: #f5faff;">
         <h3>[[Build a BCO]]</h3>
         <h3>[[Buildbcos|Build a BCO]]</h3>
<div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
<div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
The portal allows users to build a BCO using a user-friendly interface where the BCO is divided into different domain. In addition, the JSON format is also available for edit and view. By following this tutorial, users can easily build a BCO.  
The portal allows users to build a BCO using a user-friendly interface where the BCO is divided into different domain. In addition, the JSON format is also available for edit and view. By following this tutorial, users can easily build a BCO.  
Line 38: Line 35:
<div id="ggw_row3" style="display: flex; flex-flow: row wrap; justify-content: space-between; padding: 0; margin: 0 -5px 0 -5px;">
<div id="ggw_row3" style="display: flex; flex-flow: row wrap; justify-content: space-between; padding: 0; margin: 0 -5px 0 -5px;">
     <div style="flex: 1; margin: 5px; min-width: 210px; border: 1px solid #CCC; padding: 0 10px 10px 10px; box-shadow: 0 2px 2px rgba(0,0,0,0.1); background: #f5faff;">
     <div style="flex: 1; margin: 5px; min-width: 210px; border: 1px solid #CCC; padding: 0 10px 10px 10px; box-shadow: 0 2px 2px rgba(0,0,0,0.1); background: #f5faff;">
         <h3>[[Search BCOs]]</h3>
         <h3>[[Search|Search BCOs]]</h3>
         <div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
         <div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
Users can search for an existing BCO, either publish or draft through the portal. Search can be based on keywords, prefix, owned-BCO and more.  
Users can search for an existing BCO, either publish or draft through the portal. Search can be based on keywords, prefix, owned-BCO and more.  
Line 53: Line 50:
         <div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
         <div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
The BCODB sandbox is an isolated testing environment that allows developers to interact with BCO APIs without affecting the system, database, and portal. To add the BCODB sandbox to your account, please contact BioCompute Admins first.  
The BCODB sandbox is an isolated testing environment that allows developers to interact with BCO APIs without affecting the system, database, and portal. To add the BCODB sandbox to your account, please contact BioCompute Admins first.  
</div>
    </div>
</div>
    <div style="flex: 1; margin: 5px; min-width: 210px; border: 1px solid #CCC; padding: 0 10px 10px 10px; box-shadow: 0 2px 2px rgba(0,0,0,0.1); background: #f5faff;">
        <h3>[[Faq|FAQs]]</h3>
        <div style="border-top: 1px solid #CCC; padding-top: 0.5em;">
For common issues and question, refer to this page. If you need more assistance, please click on Contact Us or Bug Report.
</div>
</div>
     </div>
     </div>
</div>
</div>

Latest revision as of 21:11, 21 June 2023


Welcome to BioCompute Tutorial,
This page provides information regarding the BioCompute portal. It has several sections on different topics that will help you to navigate through most of the functions on the BioCOmpute Portal.

Account

BioCompute Team recommends all users to create an account before editing or creating a BCO. By creating an account, users can add multiple databases, edit groups/permissions, change passwords, and more.

Prefix and Permission

BioCompute portal enables users to create prefix for personal or public usage. Then, owner of the prefix can modify personnel permissions inside the group. For example, the owner can grant certain people draft only permissions and other people publish only permissions.

Build a BCO

The portal allows users to build a BCO using a user-friendly interface where the BCO is divided into different domain. In addition, the JSON format is also available for edit and view. By following this tutorial, users can easily build a BCO.

Search BCOs

Users can search for an existing BCO, either publish or draft through the portal. Search can be based on keywords, prefix, owned-BCO and more.

Swagger Usage

Users and developers can use the swagger site to interact with the BioCompute APIs to create and publish drafts.

BCODB Sandbox

The BCODB sandbox is an isolated testing environment that allows developers to interact with BCO APIs without affecting the system, database, and portal. To add the BCODB sandbox to your account, please contact BioCompute Admins first.

FAQs

For common issues and question, refer to this page. If you need more assistance, please click on Contact Us or Bug Report.