diff --git a/aboutsynbiohub/index.html b/aboutsynbiohub/index.html index a7d1bfa..823aaa2 100644 --- a/aboutsynbiohub/index.html +++ b/aboutsynbiohub/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + +
@@ -49,59 +49,59 @@ @@ -253,24 +253,24 @@

SynBioHub1 Contributors

- - + + - + - - - + + + - + - + diff --git a/aboutsynbiohub/index.xml b/aboutsynbiohub/index.xml index 1aee74c..1f21d39 100644 --- a/aboutsynbiohub/index.xml +++ b/aboutsynbiohub/index.xml @@ -2,12 +2,11 @@ About SynBioHub2 on SynBioHub-Documentation - http://localhost:1313/aboutsynbiohub/ + https://wiki2.synbiohub.org/aboutsynbiohub/ Recent content in About SynBioHub2 on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - - + Fri, 04 Sep 2020 20:30:59 +0530 diff --git a/apidocumentation/index.html b/apidocumentation/index.html index b1eae9c..addbfd9 100644 --- a/apidocumentation/index.html +++ b/apidocumentation/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + +
@@ -52,91 +52,91 @@ -
@@ -181,24 +181,24 @@

API Documentation

- - + + - + - - - + + + - + - + diff --git a/apidocumentation/index.xml b/apidocumentation/index.xml index dc3a35e..5f40287 100644 --- a/apidocumentation/index.xml +++ b/apidocumentation/index.xml @@ -2,12 +2,11 @@ API Documentation on SynBioHub-Documentation - http://localhost:1313/apidocumentation/ + https://wiki2.synbiohub.org/apidocumentation/ Recent content in API Documentation on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - - + Fri, 04 Sep 2020 20:30:59 +0530 diff --git a/categories/index.html b/categories/index.html index e2a4ff8..07f63df 100644 --- a/categories/index.html +++ b/categories/index.html @@ -49,10 +49,108 @@ diff --git a/glossary/index.html b/glossary/index.html index 2b199d1..7dc5892 100644 --- a/glossary/index.html +++ b/glossary/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + +
@@ -52,56 +52,56 @@
@@ -169,50 +169,50 @@

Glossary

This section contains definitions for various terminologies used in this documentation

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TerminologyDescription
Combine ArchiveA COMBINE archive is a single file containing the various documents (and in the future, references to documents), necessary for the description of a model and all associated data and procedures. This includes for instance, but not limited to, simulation experiment descriptions, all models needed to run the simulations and associated data files. The archive is encoded using the Open Modeling EXchange format (OMEX).
Component (Definition)Component (Definition) is used to represent biological design components such as DNA, RNA and small molecules.
FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics.
GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines.
ImageImage is a capture of the Visbol display at the top of the page.
PluginIn computing, a plug-in (or plugin, add-in, addin, add-on, or addon) is a software component that adds a specific feature to an existing computer program. When a program supports plug-ins, it enables customization. They function in a way that is similar to browser extensions. They can be installed separately from the browser/SynBioHub and provide additional ‘custom’ functionality to the browser/SynBioHub experience despite having a completely separate code base from the browser/SynBioHub.
SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology.
URIA Uniform Resource Identifier (URI) is a string of characters that unambiguously identifies a particular resource. To guarantee uniformity, all URIs follow a predefined set of syntax rules, but also maintain extensibility through a separately defined hierarchical naming scheme (e.g. http://).
Web Of RegistriesWeb of Registries concept i.e, the idea of multiple separate repositories linked together by shared common semantics. The Web Registry Service is a software component that supports the run-time discovery and evaluation of resources such as services, datasets, and application schemes.
TerminologyDescription
Combine ArchiveA COMBINE archive is a single file containing the various documents (and in the future, references to documents), necessary for the description of a model and all associated data and procedures. This includes for instance, but not limited to, simulation experiment descriptions, all models needed to run the simulations and associated data files. The archive is encoded using the Open Modeling EXchange format (OMEX).
Component (Definition)Component (Definition) is used to represent biological design components such as DNA, RNA and small molecules.
FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics.
GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines.
ImageImage is a capture of the Visbol display at the top of the page.
PluginIn computing, a plug-in (or plugin, add-in, addin, add-on, or addon) is a software component that adds a specific feature to an existing computer program. When a program supports plug-ins, it enables customization. They function in a way that is similar to browser extensions. They can be installed separately from the browser/SynBioHub and provide additional ‘custom’ functionality to the browser/SynBioHub experience despite having a completely separate code base from the browser/SynBioHub.
SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology.
URIA Uniform Resource Identifier (URI) is a string of characters that unambiguously identifies a particular resource. To guarantee uniformity, all URIs follow a predefined set of syntax rules, but also maintain extensibility through a separately defined hierarchical naming scheme (e.g. http://).
Web Of RegistriesWeb of Registries concept i.e, the idea of multiple separate repositories linked together by shared common semantics. The Web Registry Service is a software component that supports the run-time discovery and evaluation of resources such as services, datasets, and application schemes.
@@ -227,24 +227,24 @@

Glossary

- - + + - + - - - + + + - + - + diff --git a/glossary/index.xml b/glossary/index.xml index a6f19cd..02ed414 100644 --- a/glossary/index.xml +++ b/glossary/index.xml @@ -2,12 +2,11 @@ Glossary on SynBioHub-Documentation - http://localhost:1313/glossary/ + https://wiki2.synbiohub.org/glossary/ Recent content in Glossary on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - - + Wed, 02 Dec 2020 11:51:20 +0530 diff --git a/index.html b/index.html index b2323c5..02cc611 100644 --- a/index.html +++ b/index.html @@ -50,10 +50,108 @@ diff --git a/index.xml b/index.xml index 77e46d2..700eebf 100644 --- a/index.xml +++ b/index.xml @@ -6,6 +6,112 @@ Recent content on SynBioHub-Documentation Hugo -- gohugo.io en-us - © SynBioHub 2020 + © SynBioHub 2020 + Wed, 02 Dec 2020 11:51:20 +0530 + + 1. Searching for Information + https://wiki2.synbiohub.org/userdocumentation/searchingforinfo/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/userdocumentation/searchingforinfo/ + There are a variety of ways to search for information in SynBioHub, such as using keywords, sequences, advanced searches and SPARQL queries. They’re explained in detail as follows: +1.1 Keyword Search To search amongst various records, follow these steps: + Navigate to SynBioHub’s home page. + In the search box, enter the keywords for the record you want to search for and click on the search button. + Subsequently, you shall be directed to a list of records matching the keywords that you’ve entered. + + + + Mailing Lists + https://wiki2.synbiohub.org/questions-and-issues/mailinglists/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/questions-and-issues/mailinglists/ + If you are a SynBioHub developer with a question about SynBioHub or plugin development, please join the synbiohub-dev mailing list and post your question there. +If you are a SynBioHub user with a question about how to use SynBioHub, please join the synbiohub-users mailing list and post your question there. +If you have a suggestion for a new SynBioHub plugin, please make your suggestion here. + + + + 2. Viewing and Downloading the Information + https://wiki2.synbiohub.org/userdocumentation/viewinganddownloadinginformation/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/userdocumentation/viewinganddownloadinginformation/ + 2.1 Viewing the Information There are various types of records on SynBioHub. They’ve been divided into the following sub-categories: +2.1.1 Viewing a Record This section consists of a general description of all record pages i.e, this is what a general record page looks like. Additional sections (if any), are further explained in the further sections, under the respective record types. Once you’ve successfully navigated to the record’s home page, you’ll be able to view the parameters in this order: + + + + Report an Issue + https://wiki2.synbiohub.org/questions-and-issues/reportanissue/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/questions-and-issues/reportanissue/ + If you want to report an error please see the respective pages. +Note: For enhancements there are contact details in the “questions and contact” section. + This GUI documentation API documentation SynBioHub SynBioHub plugins: Please log your issue in the appropriate issue tracker for the plugin found in the table. + + + + 3. Registering and Updating an Account + https://wiki2.synbiohub.org/userdocumentation/registeringupdatingaccount/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/userdocumentation/registeringupdatingaccount/ + 3.1 Registering an Account Following Steps need to be followed for registering onto SynBioHub: + Navigate to SynBioHub’s home page. + Click on the Sign In option on the top right hand side of your Screen. + Enter the following details to complete your registration process: + Option Name Description Full Name Enter the name of the user Affiliation(Optional) You can enter the name of the university/institute that you’re currently affiliated to Email Address Enter the Email Address, through which you want to get registered. + + + + Frequently Asked Questions + https://wiki2.synbiohub.org/questions-and-issues/faq/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/questions-and-issues/faq/ + This section contains frequently asked questions. + + + + 4. Submitting, Managing and Updating Submissions + https://wiki2.synbiohub.org/userdocumentation/managingsubmitting/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/userdocumentation/managingsubmitting/ + 4.1 Submitting For submitting your designs to SynBioHub, following steps need to be followed: + Navigate to SynBioHub’s home page. + Click on the Submit option and it’ll direct you to the Submit page. + Now, there are 2 ways you make your submissions i.e, creating a new collection and then submitting your resource or submitting to an existing collection. +4.1.1 Creating a New Collection Select the New collection option. + + + + 5. Data Sharing Mechanism + https://wiki2.synbiohub.org/userdocumentation/datasharingmech/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/userdocumentation/datasharingmech/ + There are a couple of ways to share data in SynBioHub. They’re mentioned as follows: +5.1 Using the Share Option Select the collection/design that you want to share. + Click the share option. Once you click on the share option, a link shall appear. + Now, copy that link & you can share the link, thereby sharing the resource. + 5.2 Adding an Owner You can also share your design by giving any number of persons access by adding them as an owner for your design. + + + + 6. Administration + https://wiki2.synbiohub.org/userdocumentation/admin/ + Mon, 01 Jan 0001 00:00:00 +0000 + + https://wiki2.synbiohub.org/userdocumentation/admin/ + Note: The administration section will only be available, if you’re using a SynBioHub local instance. If you’re using a global instance, such as this one, then the administration section won’t be available unless you have privileged access to SynBioHub. +To access the admin page, the following steps need to be followed: + Navigate to the home page of your SynbioHub local instance. + Click on admin, in order to access the administrative settings of your instance. + + diff --git a/installation/index.html b/installation/index.html index 5b8d482..43ff218 100644 --- a/installation/index.html +++ b/installation/index.html @@ -49,10 +49,108 @@ diff --git a/plugins/index.html b/plugins/index.html index d1e9a5c..58ba5e3 100644 --- a/plugins/index.html +++ b/plugins/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + +
@@ -221,7 +221,7 @@

1.1 Types of Plugins

Download: Download plugins are available on all ‘endpoint’ pages, for example pages for components, sequences, activities, etc. Download plugins return some kind of file which is downloaded by the user.

-

Overview of Plugins

+

Overview of Plugins

2. How Do Plugins Work?

2.1 Overview

    @@ -716,24 +716,24 @@

    9. Plugins-Table

- - + + - + - - - + + + - + - + diff --git a/plugins/index.xml b/plugins/index.xml index a4653cc..31ebf84 100644 --- a/plugins/index.xml +++ b/plugins/index.xml @@ -2,12 +2,11 @@ Plugins on SynBioHub-Documentation - http://localhost:1313/plugins/ + https://wiki2.synbiohub.org/plugins/ Recent content in Plugins on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - - + Fri, 04 Sep 2020 20:30:59 +0530 diff --git a/questions-and-issues/faq/index.html b/questions-and-issues/faq/index.html index f5a17d4..dc4b23c 100644 --- a/questions-and-issues/faq/index.html +++ b/questions-and-issues/faq/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/questions-and-issues/index.html b/questions-and-issues/index.html index 602fc2e..3a18bf9 100644 --- a/questions-and-issues/index.html +++ b/questions-and-issues/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/questions-and-issues/index.xml b/questions-and-issues/index.xml index d1d5706..6079c88 100644 --- a/questions-and-issues/index.xml +++ b/questions-and-issues/index.xml @@ -2,33 +2,42 @@ Questions and Issues on SynBioHub-Documentation - http://localhost:1313/questions-and-issues/ + https://wiki2.synbiohub.org/questions-and-issues/ Recent content in Questions and Issues on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - Mon, 01 Jan 0001 00:00:00 +0000 - + Fri, 04 Sep 2020 20:30:59 +0530 Mailing Lists - http://localhost:1313/questions-and-issues/mailinglists/ + https://wiki2.synbiohub.org/questions-and-issues/mailinglists/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/questions-and-issues/mailinglists/ - <p>If you are a <strong>SynBioHub developer</strong> with a question about SynBioHub or plugin development, please join the <strong><a href="https://groups.google.com/u/1/g/synbiohub-dev">synbiohub-dev</a></strong> mailing list and post your question there.</p> <p>If you are a <strong>SynBioHub user</strong> with a question about how to use SynBioHub, please join the <strong><a href="https://groups.google.com/u/1/g/synbiohub-users">synbiohub-users</a></strong> mailing list and post your question there.</p> <p>If you have a suggestion for a new <strong>SynBioHub plugin</strong>, please make your suggestion <strong><a href="https://github.com/SynBioHub/synbiohub-plugins">here</a></strong>.</p> + + https://wiki2.synbiohub.org/questions-and-issues/mailinglists/ + If you are a SynBioHub developer with a question about SynBioHub or plugin development, please join the synbiohub-dev mailing list and post your question there. +If you are a SynBioHub user with a question about how to use SynBioHub, please join the synbiohub-users mailing list and post your question there. +If you have a suggestion for a new SynBioHub plugin, please make your suggestion here. + Report an Issue - http://localhost:1313/questions-and-issues/reportanissue/ + https://wiki2.synbiohub.org/questions-and-issues/reportanissue/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/questions-and-issues/reportanissue/ - <p>If you want to report an error please see the respective pages.</p> <p><strong>Note: For enhancements there are contact details in the &ldquo;questions and contact&rdquo; section.</strong></p> <ul> <li>This <strong><a href="https://github.com/SynBioHub/synbiohub.github.io/issues">GUI documentation</a></strong></li> <li><strong><a href="https://github.com/SynBioHub/api-docs/issues">API documentation</a></strong></li> <li><strong><a href="https://github.com/SynBioHub/synbiohub/issues">SynBioHub</a></strong></li> <li><strong>SynBioHub plugins</strong>: Please log your issue in the appropriate issue tracker for the plugin found in the <strong><a href="https://synbiohub.github.io/synbiohub-docker/#plugins">table</a></strong>.</li> </ul> + + https://wiki2.synbiohub.org/questions-and-issues/reportanissue/ + If you want to report an error please see the respective pages. +Note: For enhancements there are contact details in the &ldquo;questions and contact&rdquo; section. + This GUI documentation API documentation SynBioHub SynBioHub plugins: Please log your issue in the appropriate issue tracker for the plugin found in the table. + Frequently Asked Questions - http://localhost:1313/questions-and-issues/faq/ + https://wiki2.synbiohub.org/questions-and-issues/faq/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/questions-and-issues/faq/ - <p>This section contains frequently asked questions.</p> + + https://wiki2.synbiohub.org/questions-and-issues/faq/ + This section contains frequently asked questions. + diff --git a/questions-and-issues/mailinglists/index.html b/questions-and-issues/mailinglists/index.html index 8ac10fd..ce78ff9 100644 --- a/questions-and-issues/mailinglists/index.html +++ b/questions-and-issues/mailinglists/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/questions-and-issues/reportanissue/index.html b/questions-and-issues/reportanissue/index.html index 7bacc43..02de981 100644 --- a/questions-and-issues/reportanissue/index.html +++ b/questions-and-issues/reportanissue/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/references/index.html b/references/index.html index cf32812..8e2a1a5 100644 --- a/references/index.html +++ b/references/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/references/index.xml b/references/index.xml index 786afeb..d290b4b 100644 --- a/references/index.xml +++ b/references/index.xml @@ -2,12 +2,11 @@ References on SynBioHub-Documentation - http://localhost:1313/references/ + https://wiki2.synbiohub.org/references/ Recent content in References on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - - + Fri, 04 Sep 2020 20:30:59 +0530 diff --git a/setup/index.html b/setup/index.html index f515fcb..c41598b 100644 --- a/setup/index.html +++ b/setup/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + + @@ -174,131 +174,52 @@

Setup

-

When you’ll first install SynBioHub locally and navigate to http://localhost:7777/, you shall be directed to the setup page.

-

Over there you’ll see a welcome message saying, Congratulations, SynBioHub is successfully installed!

+

When you’ll first install SynBioHub locally and navigate to http://localhost:3333/, and the setup page will appear.

+

You will see a welcome message saying, “Congratulations, SynBioHub is successfully installed!

Then, you need to fill out some details for configuring your local instance, which are as follows:

1. Branding Your SynBioHub

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
Instance NameYou can give a name to your local instance as per your convenience. Try to provide something descriptive to identify the kind of parts your SynBioHub instance will store. This parameter can even be changed later.
Pick a colorYou can also choose a colour for you SynBioHub instance. This color shall be used to theme your SynBioHub instance. The default colour for SynBioHub is hue. If you want to change it just click on the color bar. A dropdown shall appear, enabling you to choose the color your own choice.
Write a Welcome MessageYou could also provide a welcome message for the users of your instance. This may contain a brief description of what parts does your SynBioHub contain or any other brief message that you want to give to the users about your local instance. This shall be displayed on the home page of your local instance. Html tags can also be used while writing the welcome message.
Upload a logoThen, is the option of uploading a logo for your instance. For uploading a logo of your choice, just click on upload file. A popup menu shall appear and then you can choose the picture from your machine. Kindly make sure that for best results, upload a SVG or high resolution PNG image.
Allow public account creationJust below the upload a logo option, is situated a check box displaying the message, allow public account creation. This shall enable all the users accessing your instance, to create an account on it and hence perform function such as creating collection, submitting various types of records, etc.. To enable public account creation, just check the box, right besides this message.
-
+

Pick a good Instance Name that describes what the server is. You can pick a logo for the top left of the header, and you can also change the color which will be used to theme most UI elements. +Finally you can pick if you want the instance to be pu

2. Technical Details

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
Instance URLThis displays where this SynBioHub instance is hosted on your machine, so we can assign URLs to your submissions. By default, it has been assumed that your instance is hosted at localhost:7777/. If your instance is not hosted over there, then you can change it.
URI PrefixThere is a need to know need to know how to prefix URIs of objects stored in this SynBioHub. Its default is the same as the URL, and should only be changed if you are shadowing another instance. Hence, you can change it as per your convenience.
Virtuoso INIThis basically is configuration file for the OpenLink Virtuoso VDBMS Server. There is a need to know where the Virtuoso INI is stored. By default it is guessed to be /etc/virtuoso-opensource-7/virtuoso.ini. If this is not true, you can change it as per your convenience.
Virtuoso Data DirectoryDisplays the location of Virtuoso DB directory. By default it is set to /virtuoso. If this is incorrect, you can change it as per your convenience.
-
+

You can change these, but they should already be prefilled based on your url, so we don’t recommend modifying them. If you are deploying publicly you will need to setup a reverse proxy to host both the frontend and backend at the same url and port.

3. Creating Your First User Account

You need to create a user account that will have the first privileged access to your SynBioHub local instance. For that you need to enter certain details, which are as follows:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Option NameDescription
Full NameEnter the name of the user
Affiliation(Optional)You can enter the name of the university/institute that you’re currently affiliated to
Email AddressEnter the Email Address, through which you want to get registered. If in future you forget your login credentials, then this shall be used for sending a recovery password for your account
UsernameYou have to enter a username of your own choice. This shall be displayed on the record page of every record that you submit
PasswordEnter a password (preferably a strong one) for keeping your user account safe
-
-

4. Setting up External Authorization Provider

-

External authentication basically, is the use of third-party authentication sources to decide whether a user should be allowed access to a system, and often what level of access an authenticated user enjoys on a system.

-

For a SynBioHub local instance, you’ve got 2 options i.e, none or google. If you’ll select none as your preferred authorisation provider then, you simply have to click continue.

-

To be able to use Google for authentication, you first need to register with them. This is done at their developer console. To learn more about using google as your service provider, click here. Now, if you select google as your preferred authorisation provider, then the you have to provide certain values for the following options:

- - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option NameDescription
Client IDThis is an identification string that is provided to every user by google. This number is unique for each user. For an example: XXXXXXXXXXXXXXXXXXXX.apps.googleusercontent.com, this is how a client ID provided by google looks.
Client SecretClient secret values are created for the app by the external authentication provider when the app is registered with the provider and it is a unique identification string.
Redirect URLThis is the path in your application that users are redirected to after they have authenticated with Google. The path will be appended with the authorisation code for access. It must have a protocol and cannot contain URL fragments or relative paths. Also, make sure it is not a public IP address.
Option NameDescription
Full NameEnter the name of the user
Affiliation(Optional)You can enter the name of the university/institute that you’re currently affiliated to
Email AddressEnter the Email Address, through which you want to get registered. If in future you forget your login credentials, then this shall be used for sending a recovery password for your account
UsernameYou have to enter a username of your own choice. This shall be displayed on the record page of every record that you submit
PasswordEnter a password (preferably a strong one) for keeping your user account safe
-
-

If you want to obtain your client ID and client secret, you can visit Google’s documentation for further reference.

-

Once, you’ve filled all the details, click continue. This will redirect you to the home page of your SynBioHub local instance.

+ + +

All Done

+

Once, you’ve filled all the details, click continue. This will redirect you to the home page of your SynBioHub local instance.
+
+Next lets get started installing some Plugins!

@@ -312,24 +233,24 @@

4. Setting up External Aut - - + + - + - - - + + + - + - + diff --git a/setup/index.xml b/setup/index.xml index 42ed3c7..da69859 100644 --- a/setup/index.xml +++ b/setup/index.xml @@ -2,12 +2,10 @@ Setup on SynBioHub-Documentation - http://localhost:1313/setup/ + https://wiki2.synbiohub.org/setup/ Recent content in Setup on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us - © SynBioHub 2020 - - + © SynBioHub 2020 diff --git a/sitemap.xml b/sitemap.xml index b227079..849d410 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,10 +2,52 @@ + https://wiki2.synbiohub.org/aboutsynbiohub/ + 2020-09-04T20:30:59+05:30 + + https://wiki2.synbiohub.org/userdocumentation/searchingforinfo/ + + https://wiki2.synbiohub.org/questions-and-issues/mailinglists/ + + https://wiki2.synbiohub.org/userdocumentation/viewinganddownloadinginformation/ + + https://wiki2.synbiohub.org/questions-and-issues/reportanissue/ + + https://wiki2.synbiohub.org/userdocumentation/registeringupdatingaccount/ + + https://wiki2.synbiohub.org/questions-and-issues/faq/ + + https://wiki2.synbiohub.org/userdocumentation/managingsubmitting/ + + https://wiki2.synbiohub.org/userdocumentation/datasharingmech/ + + https://wiki2.synbiohub.org/userdocumentation/admin/ + https://wiki2.synbiohub.org/installation/ + + https://wiki2.synbiohub.org/setup/ + + https://wiki2.synbiohub.org/userdocumentation/ + 2020-09-04T20:30:59+05:30 + + https://wiki2.synbiohub.org/apidocumentation/ + 2020-09-04T20:30:59+05:30 + + https://wiki2.synbiohub.org/plugins/ + 2020-09-04T20:30:59+05:30 + + https://wiki2.synbiohub.org/questions-and-issues/ + 2020-09-04T20:30:59+05:30 + + https://wiki2.synbiohub.org/glossary/ + 2020-12-02T11:51:20+05:30 https://wiki2.synbiohub.org/ + 2020-12-02T11:51:20+05:30 0 + + https://wiki2.synbiohub.org/references/ + 2020-09-04T20:30:59+05:30 https://wiki2.synbiohub.org/categories/ diff --git a/tags/index.html b/tags/index.html index 1bf9877..770a123 100644 --- a/tags/index.html +++ b/tags/index.html @@ -49,10 +49,108 @@ diff --git a/userdocumentation/admin/index.html b/userdocumentation/admin/index.html index dcf9203..3000010 100644 --- a/userdocumentation/admin/index.html +++ b/userdocumentation/admin/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + +
@@ -199,84 +202,84 @@

6. Administration

6.1 Status

Several parameters essential for the smooth functioning of SynBioHub, are mentioned in this sub-section. They’re as follows:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
parameterDescription
1. Platform: Linux x64; 4.19.76-linuxkitThis parameter represents the platform on which SynBioHub was built.
2. Node Version: vXX.X.XThis represents the node.js version, on which your local instance is running
3. Instance Name: name_of_your_choiceThis represents the name of your SynBioHub instance. This can be changed based on your convenience.
4. Listen Port: 7777When Oracle HTTP Server is started, by default, it listens for requests on port 7777 (non-SSL). If port 7777 is occupied, Oracle HTTP Server listens on the next available port number between a range of 7777-7877. Thus, if port 7777 is busy, it would listen on port 7778, and so on. To get more information on this, click here.
5. SPARQL Endpoint: http://virtuoso:8890/sparqlA SPARQL Endpoint is a Point of Presence on an HTTP network that’s capable of receiving and processing SPARQL Protocol requests. It is identified by a URL commonly referred to as a SPARQL Endpoint URL. To know more about SPARQl endpoints, click here.
6. Graph Store Endpoint: http://virtuoso:8890/sparql-graph-crud-auth/This is the endpoint for the triplestore database where the data is stored. In this case, it is the endpoint for virtuoso.
7. Default Graph: http://localhost:7777/publicIt is the URI prefix for the public graph in the database.
8. Graph Prefix: http://localhost:7777/It is the URI prefix for all graphs in the database.
9. Thread Pool Size:It is the number of threads that virtuoso is allowed to use. (But it is currently empty)
10. Upload Limit: X mbShows the maximum limit of files that you can upload at once to your instance
parameterDescription
1. Platform: Linux x64; 4.19.76-linuxkitThis parameter represents the platform on which SynBioHub was built.
2. Node Version: vXX.X.XThis represents the node.js version, on which your local instance is running
3. Instance Name: name_of_your_choiceThis represents the name of your SynBioHub instance. This can be changed based on your convenience.
4. Listen Port: 7777When Oracle HTTP Server is started, by default, it listens for requests on port 7777 (non-SSL). If port 7777 is occupied, Oracle HTTP Server listens on the next available port number between a range of 7777-7877. Thus, if port 7777 is busy, it would listen on port 7778, and so on. To get more information on this, click here.
5. SPARQL Endpoint: http://virtuoso:8890/sparqlA SPARQL Endpoint is a Point of Presence on an HTTP network that’s capable of receiving and processing SPARQL Protocol requests. It is identified by a URL commonly referred to as a SPARQL Endpoint URL. To know more about SPARQl endpoints, click here.
6. Graph Store Endpoint: http://virtuoso:8890/sparql-graph-crud-auth/This is the endpoint for the triplestore database where the data is stored. In this case, it is the endpoint for virtuoso.
7. Default Graph: http://localhost:7777/publicIt is the URI prefix for the public graph in the database.
8. Graph Prefix: http://localhost:7777/It is the URI prefix for all graphs in the database.
9. Thread Pool Size:It is the number of threads that virtuoso is allowed to use. (But it is currently empty)
10. Upload Limit: X mbShows the maximum limit of files that you can upload at once to your instance

6.2 Graphs

This section basically displays the graph URI and its corresponding triples. You can select the number of graphs you want to view on one page as well as search for any specific graphs, with the help of search box. You can also sort the graphs on the basis of number of triples.

6.3 Log

This section displays the log file for your SynBioHub local instance. You can view 4 types of logs, which are as follows:

- - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
Name of the LogDescription
ErrorError log is a record of critical errors that are encountered by SynBioHub, while in operation. Some of the common entries in an error log include table corruption and configuration corruption. Error logs in many cases serve as extremely useful tools for troubleshooting and managing systems, servers and even networks.
WarnUsed just to draw your attention, but it is considered to be a normal activity usually and does not require any action
InfoFor standard, normally occurring operations.
DebugThese types of logs just give out the debug information.
Name of the LogDescription
ErrorError log is a record of critical errors that are encountered by SynBioHub, while in operation. Some of the common entries in an error log include table corruption and configuration corruption. Error logs in many cases serve as extremely useful tools for troubleshooting and managing systems, servers and even networks.
WarnUsed just to draw your attention, but it is considered to be a normal activity usually and does not require any action
InfoFor standard, normally occurring operations.
DebugThese types of logs just give out the debug information.

You may use the pointer to view differs types of logs.

@@ -397,62 +400,62 @@

6.7.1 Configuring a Benchling Remote - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescription
1. IDEnter ID of the benchling remote.
2. TypeThis shall display the type of remote that you would’ve chosen, initially.
3. URLEnter the URL for the benchling remote.
4. Sequence SuffixThis represents the suffix to use for the sequences found on benchling.
5. Default Folder IDEnter the default folder on benchling to access.
6. PublicShould be checked, if you want the remote to be visible publicly. If not, then it should not be checked.
7. Reject UnauthorizedShould be checked, if you want to the SSL certificates to be checked. If not, then it should not be checked.
8. Folder PrefixRepresents the prefix to use for folders on benchling.
9. Root Collection Display IDRepresents the display id for the root collection on the remote.
10. Root Collection NameThis represents the name for the root collection on the remote.
11. Root Collection DescriptionA brief description about the root collection on the remote.
12. Benchling API TokenThe token generated by benchling should be entered here.
AttributeDescription
1. IDEnter ID of the benchling remote.
2. TypeThis shall display the type of remote that you would’ve chosen, initially.
3. URLEnter the URL for the benchling remote.
4. Sequence SuffixThis represents the suffix to use for the sequences found on benchling.
5. Default Folder IDEnter the default folder on benchling to access.
6. PublicShould be checked, if you want the remote to be visible publicly. If not, then it should not be checked.
7. Reject UnauthorizedShould be checked, if you want to the SSL certificates to be checked. If not, then it should not be checked.
8. Folder PrefixRepresents the prefix to use for folders on benchling.
9. Root Collection Display IDRepresents the display id for the root collection on the remote.
10. Root Collection NameThis represents the name for the root collection on the remote.
11. Root Collection DescriptionA brief description about the root collection on the remote.
12. Benchling API TokenThe token generated by benchling should be entered here.

Once you are through with all the attributes, click on submit.

@@ -488,90 +491,90 @@

6.7.2 Configuring an ICE Remote

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescription
1. IDEnter ID of the ICE remote.
2. TypeThis shall display the type of remote that you would’ve chosen, initially.
3. URLEnter the URL for the ICE remote.
4. Sequence SuffixThis represents the suffix to use for the sequences found on ICE.
5. Default Folder IDEnter the default folder on ICE to access.
6. PublicShould be checked, if you want the remote to be visible publicly. If not, then it should not be checked.
7. Reject UnauthorizedShould be checked, if you want to the SSL certificates to be checked. If not, then it should not be checked.
8. Folder PrefixRepresents the prefix to use for folders on ICE.
9. Root Collection Display IDRepresents the display id for the root collection on the remote.
10. Root Collection NameThis represents the name for the root collection on the remote.
11. Root Collection DescriptionA brief description about the root collection on the remote.
12. ICE API TokenThe token generated by ICE should be entered here.
13. ICE API Token ClientDomain of the client using the ICE API.
14. ICE API Token OwnerEmail address of the client using the ICE API.
15. ICE CollectionName of the ICE collection.
16. Group IDID number for the ICE group.
17. PIPrincipal Investigator name should be entered.
18. PI EmailPrincipal Investigator email should be entered.
19. Part Number PrefixPrefix that is to be used for the parts.
AttributeDescription
1. IDEnter ID of the ICE remote.
2. TypeThis shall display the type of remote that you would’ve chosen, initially.
3. URLEnter the URL for the ICE remote.
4. Sequence SuffixThis represents the suffix to use for the sequences found on ICE.
5. Default Folder IDEnter the default folder on ICE to access.
6. PublicShould be checked, if you want the remote to be visible publicly. If not, then it should not be checked.
7. Reject UnauthorizedShould be checked, if you want to the SSL certificates to be checked. If not, then it should not be checked.
8. Folder PrefixRepresents the prefix to use for folders on ICE.
9. Root Collection Display IDRepresents the display id for the root collection on the remote.
10. Root Collection NameThis represents the name for the root collection on the remote.
11. Root Collection DescriptionA brief description about the root collection on the remote.
12. ICE API TokenThe token generated by ICE should be entered here.
13. ICE API Token ClientDomain of the client using the ICE API.
14. ICE API Token OwnerEmail address of the client using the ICE API.
15. ICE CollectionName of the ICE collection.
16. Group IDID number for the ICE group.
17. PIPrincipal Investigator name should be entered.
18. PI EmailPrincipal Investigator email should be entered.
19. Part Number PrefixPrefix that is to be used for the parts.

    @@ -741,24 +744,24 @@

    6.11 Users

- - + + - + - - - + + + - + - + diff --git a/userdocumentation/datasharingmech/index.html b/userdocumentation/datasharingmech/index.html index 2d7ed64..3ec7312 100644 --- a/userdocumentation/datasharingmech/index.html +++ b/userdocumentation/datasharingmech/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/userdocumentation/index.html b/userdocumentation/index.html index 184ca07..565aca9 100644 --- a/userdocumentation/index.html +++ b/userdocumentation/index.html @@ -1,11 +1,11 @@ - + - - + + @@ -14,31 +14,31 @@ - + - + + + + + - - + + - + - - - + + + - + - + diff --git a/userdocumentation/index.xml b/userdocumentation/index.xml index a063134..6837b41 100644 --- a/userdocumentation/index.xml +++ b/userdocumentation/index.xml @@ -2,54 +2,85 @@ User Documentation on SynBioHub-Documentation - http://localhost:1313/userdocumentation/ + https://wiki2.synbiohub.org/userdocumentation/ Recent content in User Documentation on SynBioHub-Documentation - Hugo + Hugo -- gohugo.io en-us © SynBioHub 2020 - Mon, 01 Jan 0001 00:00:00 +0000 - + Fri, 04 Sep 2020 20:30:59 +0530 1. Searching for Information - http://localhost:1313/userdocumentation/searchingforinfo/ + https://wiki2.synbiohub.org/userdocumentation/searchingforinfo/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/userdocumentation/searchingforinfo/ - <p>There are a variety of ways to search for information in SynBioHub, such as using keywords, sequences, advanced searches and SPARQL queries. They&rsquo;re explained in detail as follows:</p> <h3 id="11-keyword-search">1.1 Keyword Search</h3> <p>To search amongst various records, follow these steps:</p> <ol> <li> <p>Navigate to SynBioHub&rsquo;s home page.</p> </li> <li> <p>In the search box, enter the keywords for the record you want to search for and click on the search button.</p> </li> <li> <p>Subsequently, you shall be directed to a list of records matching the keywords that you&rsquo;ve entered. For each record, the first thing that is displayed is the name. Next to the name, the display ID, description and type of the record and privacy shall be displayed. The description column contains a brief description provided by the owner of that particulat record. On the right hand side, there is an indicator displaying whether it is a <strong>public</strong>, <strong>private</strong> or a <strong>remote</strong> record. The privacy labels indicate:</p> + + https://wiki2.synbiohub.org/userdocumentation/searchingforinfo/ + There are a variety of ways to search for information in SynBioHub, such as using keywords, sequences, advanced searches and SPARQL queries. They&rsquo;re explained in detail as follows: +1.1 Keyword Search To search amongst various records, follow these steps: + Navigate to SynBioHub&rsquo;s home page. + In the search box, enter the keywords for the record you want to search for and click on the search button. + Subsequently, you shall be directed to a list of records matching the keywords that you&rsquo;ve entered. + 2. Viewing and Downloading the Information - http://localhost:1313/userdocumentation/viewinganddownloadinginformation/ + https://wiki2.synbiohub.org/userdocumentation/viewinganddownloadinginformation/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/userdocumentation/viewinganddownloadinginformation/ - <h2 id="21-viewing-the-information">2.1 Viewing the Information</h2> <p>There are various types of records on SynBioHub. They&rsquo;ve been divided into the following sub-categories:</p> <h3 id="211-viewing-a-record">2.1.1 Viewing a Record</h3> <p>This section consists of a general description of all record pages i.e, this is what a general record page looks like. Additional sections (if any), are further explained in the further sections, under the respective record types. Once you&rsquo;ve successfully navigated to the record&rsquo;s home page, you&rsquo;ll be able to view the parameters in this order:</p> + + https://wiki2.synbiohub.org/userdocumentation/viewinganddownloadinginformation/ + 2.1 Viewing the Information There are various types of records on SynBioHub. They&rsquo;ve been divided into the following sub-categories: +2.1.1 Viewing a Record This section consists of a general description of all record pages i.e, this is what a general record page looks like. Additional sections (if any), are further explained in the further sections, under the respective record types. Once you&rsquo;ve successfully navigated to the record&rsquo;s home page, you&rsquo;ll be able to view the parameters in this order: + 3. Registering and Updating an Account - http://localhost:1313/userdocumentation/registeringupdatingaccount/ + https://wiki2.synbiohub.org/userdocumentation/registeringupdatingaccount/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/userdocumentation/registeringupdatingaccount/ - <h2 id="31-registering-an-account">3.1 Registering an Account</h2> <p>Following Steps need to be followed for registering onto SynBioHub:</p> <ol> <li> <p>Navigate to SynBioHub&rsquo;s home page.</p> </li> <li> <p>Click on the <strong>Sign In</strong> option on the top right hand side of your Screen.</p> </li> <li> <p>Enter the following details to complete your registration process:</p> </li> </ol> <table> <thead> <tr> <th>Option Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Full Name</td> <td>Enter the name of the user</td> </tr> <tr> <td>Affiliation(Optional)</td> <td>You can enter the name of the university/institute that you&rsquo;re currently affiliated to</td> </tr> <tr> <td>Email Address</td> <td>Enter the Email Address, through which you want to get registered. If in future you forget your login credentials, then this shall be used for sending a recovery password for your account</td> </tr> <tr> <td>Username</td> <td>You have to enter a username of your own choice. This shall be displayed on the record page of every record that you submit</td> </tr> <tr> <td>Password</td> <td>Enter a password (preferably a strong one) for keeping your user account safe</td> </tr> </tbody> </table> <hr> <ol start="4"> <li>When you need to login into your SynBioHub account, click on the &ldquo;login or Register&rdquo; option. Then you need to enter your email address and your password to access your account.</li> </ol> <h3 id="32-updating-an-account">3.2 Updating an Account</h3> <p>If you ever need to update your account, the following steps need to be followed:</p> + + https://wiki2.synbiohub.org/userdocumentation/registeringupdatingaccount/ + 3.1 Registering an Account Following Steps need to be followed for registering onto SynBioHub: + Navigate to SynBioHub&rsquo;s home page. + Click on the Sign In option on the top right hand side of your Screen. + Enter the following details to complete your registration process: + Option Name Description Full Name Enter the name of the user Affiliation(Optional) You can enter the name of the university/institute that you&rsquo;re currently affiliated to Email Address Enter the Email Address, through which you want to get registered. + 4. Submitting, Managing and Updating Submissions - http://localhost:1313/userdocumentation/managingsubmitting/ + https://wiki2.synbiohub.org/userdocumentation/managingsubmitting/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/userdocumentation/managingsubmitting/ - <h2 id="41-submitting">4.1 Submitting</h2> <p>For submitting your designs to SynBioHub, following steps need to be followed:</p> <ol> <li> <p>Navigate to SynBioHub&rsquo;s home page.</p> </li> <li> <p>Click on the <strong>Submit</strong> option and it&rsquo;ll direct you to the Submit page.</p> </li> </ol> <p>Now, there are 2 ways you make your submissions i.e, creating a new collection and then submitting your resource or submitting to an existing collection.</p> <h3 id="411-creating-a-new-collection">4.1.1 Creating a New Collection</h3> <ol> <li> <p>Select the <strong>New collection</strong> option.</p> </li> <li> <p>Following are the attributes that need to be filled up :</p> + + https://wiki2.synbiohub.org/userdocumentation/managingsubmitting/ + 4.1 Submitting For submitting your designs to SynBioHub, following steps need to be followed: + Navigate to SynBioHub&rsquo;s home page. + Click on the Submit option and it&rsquo;ll direct you to the Submit page. + Now, there are 2 ways you make your submissions i.e, creating a new collection and then submitting your resource or submitting to an existing collection. +4.1.1 Creating a New Collection Select the New collection option. + 5. Data Sharing Mechanism - http://localhost:1313/userdocumentation/datasharingmech/ + https://wiki2.synbiohub.org/userdocumentation/datasharingmech/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/userdocumentation/datasharingmech/ - <p>There are a couple of ways to share data in SynBioHub. They&rsquo;re mentioned as follows:</p> <h3 id="51-using-the-share-option">5.1 Using the Share Option</h3> <ol> <li> <p>Select the collection/design that you want to share.</p> </li> <li> <p>Click the <strong>share</strong> option. Once you click on the share option, a link shall appear.</p> </li> <li> <p>Now, copy that link &amp; you can share the link, thereby sharing the resource.</p> </li> </ol> <h3 id="52-adding-an-owner">5.2 Adding an Owner</h3> <p>You can also share your design by giving any number of persons access by adding them as an owner for your design. This will give them full administrative access to your resources. The steps to do so are as follows:</p> + + https://wiki2.synbiohub.org/userdocumentation/datasharingmech/ + There are a couple of ways to share data in SynBioHub. They&rsquo;re mentioned as follows: +5.1 Using the Share Option Select the collection/design that you want to share. + Click the share option. Once you click on the share option, a link shall appear. + Now, copy that link &amp; you can share the link, thereby sharing the resource. + 5.2 Adding an Owner You can also share your design by giving any number of persons access by adding them as an owner for your design. + 6. Administration - http://localhost:1313/userdocumentation/admin/ + https://wiki2.synbiohub.org/userdocumentation/admin/ Mon, 01 Jan 0001 00:00:00 +0000 - http://localhost:1313/userdocumentation/admin/ - <p>Note: <strong>The administration section will only be available, if you&rsquo;re using a SynBioHub local instance. If you&rsquo;re using a global instance, such as <a href="https://synbiohub.org/">this</a> one, then the administration section won&rsquo;t be available unless you have privileged access to SynBioHub.</strong></p> <p>To access the admin page, the following steps need to be followed:</p> <ol> <li> <p>Navigate to the home page of your SynbioHub local instance.</p> </li> <li> <p>Click on <strong>admin</strong>, in order to access the administrative settings of your instance. This will direct you to the administrative page. It has been divided into several sub-sections, for your convenience. They&rsquo;re discussed in detail, as follows:</p> + + https://wiki2.synbiohub.org/userdocumentation/admin/ + Note: The administration section will only be available, if you&rsquo;re using a SynBioHub local instance. If you&rsquo;re using a global instance, such as this one, then the administration section won&rsquo;t be available unless you have privileged access to SynBioHub. +To access the admin page, the following steps need to be followed: + Navigate to the home page of your SynbioHub local instance. + Click on admin, in order to access the administrative settings of your instance. + diff --git a/userdocumentation/managingsubmitting/index.html b/userdocumentation/managingsubmitting/index.html index 5906f2a..0d9cb9a 100644 --- a/userdocumentation/managingsubmitting/index.html +++ b/userdocumentation/managingsubmitting/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + +
@@ -217,30 +220,30 @@

4.1.1 Creating a New Collection

- - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology.
GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines.
FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics.
zipZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed.
TypeDescription
SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology.
GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines.
FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics.
zipZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed.

	Inorder to submit a file you must have already submitted the collection. Once you do you can click **Submit** and it will submit to the collection just created.
@@ -269,34 +272,34 @@ 

4.1.2 Submitting to an Existin - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology. To know more about SBOL, visit this page
Annotated zipZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. To know more about zip, visit this page
GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines. To know more about GFF3, click here.
FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics. To know more about FATSA file format, click here
ZipZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. To know more about zip, visit this page
TypeDescription
SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology. To know more about SBOL, visit this page
Annotated zipZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. To know more about zip, visit this page
GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines. To know more about GFF3, click here.
FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics. To know more about FATSA file format, click here
ZipZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. To know more about zip, visit this page

    @@ -421,24 +424,24 @@

    4.5 Add to an Existing Collection

- - + + - + - - - + + + - + - + diff --git a/userdocumentation/registeringupdatingaccount/index.html b/userdocumentation/registeringupdatingaccount/index.html index e53889e..d80d0cd 100644 --- a/userdocumentation/registeringupdatingaccount/index.html +++ b/userdocumentation/registeringupdatingaccount/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + +
@@ -185,34 +188,34 @@

3.1 Registering an Account

- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option NameDescription
Full NameEnter the name of the user
Affiliation(Optional)You can enter the name of the university/institute that you’re currently affiliated to
Email AddressEnter the Email Address, through which you want to get registered. If in future you forget your login credentials, then this shall be used for sending a recovery password for your account
UsernameYou have to enter a username of your own choice. This shall be displayed on the record page of every record that you submit
PasswordEnter a password (preferably a strong one) for keeping your user account safe
Option NameDescription
Full NameEnter the name of the user
Affiliation(Optional)You can enter the name of the university/institute that you’re currently affiliated to
Email AddressEnter the Email Address, through which you want to get registered. If in future you forget your login credentials, then this shall be used for sending a recovery password for your account
UsernameYou have to enter a username of your own choice. This shall be displayed on the record page of every record that you submit
PasswordEnter a password (preferably a strong one) for keeping your user account safe

    @@ -244,24 +247,24 @@

    3.2 Updating an Account

- - + + - + - - - + + + - + - + diff --git a/userdocumentation/searchingforinfo/index.html b/userdocumentation/searchingforinfo/index.html index 36fa769..d5fa3a8 100644 --- a/userdocumentation/searchingforinfo/index.html +++ b/userdocumentation/searchingforinfo/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + +
@@ -205,96 +208,96 @@

On the search results page, there is button labeled as sequence search. Clicking on that button will direct you to a page containing a list of sequence search options. To search using a sequence, you can provide the values for the options, as described in the table below:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option NameDescription
Enter SequenceEnter the sequence or upload a FASTA/FASTQ file, by clicking the choose file option just below the box. This shall search only for exact matches of the sequence. Your entry must be the first key/value pair
Search MethodYou can choose the perspective of your search. You can perform a global search or an exact search. The exact search shall display, those records which are an exact match to the sequences that you’ve entered and the global search search will display those results which have even the smallest of the similarities to the sequence that you’ve entered.
Number of ResultsYou may customise the number of results, the value for which must not exceed 10,000. This translates into the maximum number of hits to accept before stopping the search. Kindly note that, higher the value, the longer the runtime.
Minimum Sequence LengthYou need to enter the minimum sequence length. This value basically specifies the minimum length of the sequence, which you want to search for. Values for this parameter should not exceed 100,000.
Maximum Sequence LengthYou need to enter the maximum sequence length. This value basically specifies the maximum length of the sequence, which you want to search for. Values for this parameter should not exceed 100,000.
# of failed hits before stoppingThen, you need to enter the maximum number of non-matching target sequences, that are to be considered before the search is halted. This option works in pair with the flag above. The search process sorts the target sequences by decreasing number of k-mers they have in common with the query sequence, using that information as a proxy for sequence similarity. After pairwise alignments, if none of the first x examined target sequences pass the acceptation criteria, the search process stops for that query (no hit). If this flag is set to a higher value, more target sequences are considered. If the flag above and this flag are both set to 0, the complete database is searched.
Percent MatchThen, we have is the percentage match, which has a value between 0 and 1. This is the value of pairwise identity that must match with the sequence, otherwise the sequence is rejected.
Pairwise Identity DefinitionYou may select the value for this attribute from the following options: 1) Default: Edits distance excluding the terminal gaps, 2) CD-HIT definition: Considers the following ratio: (matching columns) / (shortest sequence length), 3) Marine Biological Lab definition: counts each gap opening (internal or terminal) as a single mismatch, whether or not the gap was extended: 1.0 - [(mismatches + gap openings)/(longest sequence length)], 4) BLAST Definition: equivalent to edit distance for global pairwise alignments
Option NameDescription
Enter SequenceEnter the sequence or upload a FASTA/FASTQ file, by clicking the choose file option just below the box. This shall search only for exact matches of the sequence. Your entry must be the first key/value pair
Search MethodYou can choose the perspective of your search. You can perform a global search or an exact search. The exact search shall display, those records which are an exact match to the sequences that you’ve entered and the global search search will display those results which have even the smallest of the similarities to the sequence that you’ve entered.
Number of ResultsYou may customise the number of results, the value for which must not exceed 10,000. This translates into the maximum number of hits to accept before stopping the search. Kindly note that, higher the value, the longer the runtime.
Minimum Sequence LengthYou need to enter the minimum sequence length. This value basically specifies the minimum length of the sequence, which you want to search for. Values for this parameter should not exceed 100,000.
Maximum Sequence LengthYou need to enter the maximum sequence length. This value basically specifies the maximum length of the sequence, which you want to search for. Values for this parameter should not exceed 100,000.
# of failed hits before stoppingThen, you need to enter the maximum number of non-matching target sequences, that are to be considered before the search is halted. This option works in pair with the flag above. The search process sorts the target sequences by decreasing number of k-mers they have in common with the query sequence, using that information as a proxy for sequence similarity. After pairwise alignments, if none of the first x examined target sequences pass the acceptation criteria, the search process stops for that query (no hit). If this flag is set to a higher value, more target sequences are considered. If the flag above and this flag are both set to 0, the complete database is searched.
Percent MatchThen, we have is the percentage match, which has a value between 0 and 1. This is the value of pairwise identity that must match with the sequence, otherwise the sequence is rejected.
Pairwise Identity DefinitionYou may select the value for this attribute from the following options: 1) Default: Edits distance excluding the terminal gaps, 2) CD-HIT definition: Considers the following ratio: (matching columns) / (shortest sequence length), 3) Marine Biological Lab definition: counts each gap opening (internal or terminal) as a single mismatch, whether or not the gap was extended: 1.0 - [(mismatches + gap openings)/(longest sequence length)], 4) BLAST Definition: equivalent to edit distance for global pairwise alignments

After filling up the desired options, press the search button to get the search results.

On the search results page, there is collumn on the left hand side it contains a list of advanced search options. To search using advanced parameters, you can provide the values for the option as described in the table below. The records that’ll be displayed will match all of the criteria, that you’ll fill in. Kindly note that you don’t need to fill in all of the options. The options are as follows:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option NameDescription
Object TypeThe type of the record you want to search for i.e, a collection, design, activity, etc…
CreatorThe username of the record’s creator
Created After and Created BeforeThe timeframe in which the record was created. Make sure to enter the dates in the YYYY-MM-DD format
Modified After Modified BeforeThe timeframe in which the record was last modified. Make sure to enter the dates in the YYYY-MM-DD format
ID/Name/DescriptionEnter the ID or the name or the description of the record, which you want to search for
TypeSelect the type of the record, from the following available options in the dropdown menu, for an example: No filter, biopax:Complex, biopax:DnaRegion, biopax:Protein, so:circular, etc…
Roleselect the role of the record from this dropdown menu. It contains various sub-categories of igem or SO.
CollectionsYou may select any number of collections, based on your convenience. To select a collection, click on the value attribute of collection and select it from the drop down menu
Customisable FiltersYou may apply customised filters for the design you want to search for. For that purpose, click add filter and a drop down menu will appear having various parameters for filtering. These parameters are basically, the properties for filtering the records. Select the property that you want your record to be filtered by, and then click on filter. This shall reload the page and then select the value of the filter, from the drop down on the right hand side. You may provide as many as 5 customised filters which’er optional
Option NameDescription
Object TypeThe type of the record you want to search for i.e, a collection, design, activity, etc…
CreatorThe username of the record’s creator
Created After and Created BeforeThe timeframe in which the record was created. Make sure to enter the dates in the YYYY-MM-DD format
Modified After Modified BeforeThe timeframe in which the record was last modified. Make sure to enter the dates in the YYYY-MM-DD format
ID/Name/DescriptionEnter the ID or the name or the description of the record, which you want to search for
TypeSelect the type of the record, from the following available options in the dropdown menu, for an example: No filter, biopax:Complex, biopax:DnaRegion, biopax:Protein, so:circular, etc…
Roleselect the role of the record from this dropdown menu. It contains various sub-categories of igem or SO.
CollectionsYou may select any number of collections, based on your convenience. To select a collection, click on the value attribute of collection and select it from the drop down menu
Customisable FiltersYou may apply customised filters for the design you want to search for. For that purpose, click add filter and a drop down menu will appear having various parameters for filtering. These parameters are basically, the properties for filtering the records. Select the property that you want your record to be filtered by, and then click on filter. This shall reload the page and then select the value of the filter, from the drop down on the right hand side. You may provide as many as 5 customised filters which’er optional

After selecting the desired options for performing a search using advanced parameters, click search. This will return the records after comprehending all the details that you’ve entered.

@@ -302,30 +305,30 @@
  • Just below, there is an option to create a new collection as well. If you wish to create a collection from your search results, you need to fill in the following items:
  • - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
    Option NameDescription
    Collection NameThis is the name string that’ll be assigned to the submission.
    Collection DescriptionThis is the description string that briefly explains your submission.
    Collection IDThis is a user-defined alphanumeric string identifier for the submission and it should contain alphanumeric and underscores characters only.
    Collection VersionThis is the alphanumeric string which is associated with the submission.
    Option NameDescription
    Collection NameThis is the name string that’ll be assigned to the submission.
    Collection DescriptionThis is the description string that briefly explains your submission.
    Collection IDThis is a user-defined alphanumeric string identifier for the submission and it should contain alphanumeric and underscores characters only.
    Collection VersionThis is the alphanumeric string which is associated with the submission.

    After you’ve filled in all the available options, click on create collection. This will return the search results to you, in the form a private collection.

    @@ -379,24 +382,24 @@

    1.5.3 Search for Similar Components

    - - + + - + - - - + + + - + - + diff --git a/userdocumentation/viewinganddownloadinginformation/index.html b/userdocumentation/viewinganddownloadinginformation/index.html index f651990..8488984 100644 --- a/userdocumentation/viewinganddownloadinginformation/index.html +++ b/userdocumentation/viewinganddownloadinginformation/index.html @@ -1,10 +1,10 @@ - + - + @@ -13,28 +13,31 @@ - + - + + + + +
    @@ -281,30 +284,30 @@

    2.1.2 Viewing a Collection

    The header of the table as explained as follows:

    - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +
    Table HeaderDescription
    NameThis contains the name of each and every record that is in that collection, that is provided by the user who had submitted that particular record. Just besides the header there is small figure, clicking on which shall sort this table on the basis of reverse priority of alphabets i.e, Z-A
    IdentifierThis contains the ID or the identifier of that particular record,that is provided by the user who had submitted that particular record. ust besides the header there is small figure, clicking on which shall sort this table on the basis of reverse priority of alphabets i.e, Z-A
    TypeThis represents the type of the record, i.e. whether it is a module, sequence, activity, etc.
    DescriptionThis is a brief description, that is provided by the user, who’d submitted that particular records. This description, in brief describes, what that particular record does.
    Table HeaderDescription
    NameThis contains the name of each and every record that is in that collection, that is provided by the user who had submitted that particular record. Just besides the header there is small figure, clicking on which shall sort this table on the basis of reverse priority of alphabets i.e, Z-A
    IdentifierThis contains the ID or the identifier of that particular record,that is provided by the user who had submitted that particular record. ust besides the header there is small figure, clicking on which shall sort this table on the basis of reverse priority of alphabets i.e, Z-A
    TypeThis represents the type of the record, i.e. whether it is a module, sequence, activity, etc.
    DescriptionThis is a brief description, that is provided by the user, who’d submitted that particular records. This description, in brief describes, what that particular record does.

    2.1.3 Viewing a Module (Definition)

    @@ -316,99 +319,99 @@

    2.1.3 Viewing a Module (Definition)

    Just below the clickable options, the VisBol navigator is located, which displays the structure of that particular module. VisBOL is a Web-based application that allows the rendering of genetic circuit designs, enabling synthetic biologists to visually convey designs in SBOL visual format. VisBOL designs can be exported to formats including PNG and SVG images to be embedded in Web pages, presentations and publications. The VisBOL tool enables the automated generation of visualizations from designs specified using the Synthetic Biology Open Language (SBOL) version 2.0, as well as a range of well-known bioinformatics formats including GenBank and Pigeoncad notation. VisBOL Navigator also has zooming capabilities. This, graphically represents the structure of the module. By hovering your pointer over this structure, you can view the following attributes of that particular module i.e, type of resource, identifier, name and role of the module.

    Then, what we have is the section titled, functional components. A FunctionalComponent is an instance of a ComponentDefinition being used as part of a ModuleDefinition. The ModuleDefinition describes how the that describes how the FunctionalComponent interacts with others and summarizes their aggregate function. The parameters included in this section are described in the table below:

    - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
    Parameter NameDescription
    Access/Direction1) Access: The access property is a REQUIRED URI that indicates whether the ComponentInstance can be referred to remotely by a MapsTo on another ComponentInstance or Module contained by a different parent ComponentDefinition or ModuleDefinition (one that does not contain this ComponentInstance). 2) Direction:Each FunctionalComponent MUST specify via the direction property whether it serves as an input, output, both, or neither for its parent ModuleDefinition object.
    Definition and MapsTo1) Definition: The definition property is a REQUIRED URI that refers to the ComponentDefinition of the ComponentInstance. ComponentDefinition effectively provides information about the types and roles of the ComponentInstance. 2) MapsTo: When ComponentDefinition and ModuleDefinition objects are composed into structural and functional hierarchies using ComponentInstance and Module objects, it is often the case that some ComponentInstance objects are intended to represent the same entity in the overall design. The purpose of the MapsTo class is to make these identity relationships clear and explicit. For example, consider a ModuleDefinition for a genetic inverter that includes a FunctionalComponent for an abstract repressor protein. When this ModuleDefinition is instantiated within a “higher level” ModuleDefinition that includes a FunctionalComponent for a LacI protein, the MapsTo object can be used to indicate that the repressor protein in the first ModuleDefinition is LacI in the context of the composite design.
    Public and Inout1) Public: Indicates that a ComponentInstance MAY be referred to by remote MapsTo objects. 2) Inout: Indicates that the FunctionalComponent is both an input and output.
    Parameter NameDescription
    Access/Direction1) Access: The access property is a REQUIRED URI that indicates whether the ComponentInstance can be referred to remotely by a MapsTo on another ComponentInstance or Module contained by a different parent ComponentDefinition or ModuleDefinition (one that does not contain this ComponentInstance). 2) Direction:Each FunctionalComponent MUST specify via the direction property whether it serves as an input, output, both, or neither for its parent ModuleDefinition object.
    Definition and MapsTo1) Definition: The definition property is a REQUIRED URI that refers to the ComponentDefinition of the ComponentInstance. ComponentDefinition effectively provides information about the types and roles of the ComponentInstance. 2) MapsTo: When ComponentDefinition and ModuleDefinition objects are composed into structural and functional hierarchies using ComponentInstance and Module objects, it is often the case that some ComponentInstance objects are intended to represent the same entity in the overall design. The purpose of the MapsTo class is to make these identity relationships clear and explicit. For example, consider a ModuleDefinition for a genetic inverter that includes a FunctionalComponent for an abstract repressor protein. When this ModuleDefinition is instantiated within a “higher level” ModuleDefinition that includes a FunctionalComponent for a LacI protein, the MapsTo object can be used to indicate that the repressor protein in the first ModuleDefinition is LacI in the context of the composite design.
    Public and Inout1) Public: Indicates that a ComponentInstance MAY be referred to by remote MapsTo objects. 2) Inout: Indicates that the FunctionalComponent is both an input and output.

    Subsequently, just below the functional components we have the Interactions section. Interaction basically, provides a more detailed description of how the FunctionalComponent objects of a ModuleDefinition are intended to work together. It has a table consisting of the following attributes:

    - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
    NameDescription
    Interaction/Participation1) Interaction: Provides more detailed description of how the FunctionalComponent objects of a ModuleDefinition are intended to work together. 2) Participation: Each Participation represents how a particular FunctionalComponent behaves in its parent Interaction.
    Participant DefinitionThe definition property is a REQUIRED URI that refers to the ComponentDefinition of the ComponentInstance. As described in the previous section, this ComponentDefinition effectively provides information about the types and roles of the ComponentInstance.
    Type/Role1) Type: Specifies the category of biochemical or physical entity. For example DNA, protein, or small molecule that a ComponentDefinition object abstracts for the purpose of engineering design. For DNA or RNA entities, additional types fields are used to describe nucleic acid topology (circular / linear) and strandedness (double- or single-stranded). 2) Role: Clarifies the potential function of an entity in a biochemical or physical context. When it is used for ComponentDefinitions, it MUST identify terms from ontologies that are consistent with the types property of the ComponentDefinition. For example, the roles property of a DNA or RNA ComponentDefinition could contain URIs identifying terms from the Sequence Ontology (SO). It may be a product, genetic production, template, etc.
    NameDescription
    Interaction/Participation1) Interaction: Provides more detailed description of how the FunctionalComponent objects of a ModuleDefinition are intended to work together. 2) Participation: Each Participation represents how a particular FunctionalComponent behaves in its parent Interaction.
    Participant DefinitionThe definition property is a REQUIRED URI that refers to the ComponentDefinition of the ComponentInstance. As described in the previous section, this ComponentDefinition effectively provides information about the types and roles of the ComponentInstance.
    Type/Role1) Type: Specifies the category of biochemical or physical entity. For example DNA, protein, or small molecule that a ComponentDefinition object abstracts for the purpose of engineering design. For DNA or RNA entities, additional types fields are used to describe nucleic acid topology (circular / linear) and strandedness (double- or single-stranded). 2) Role: Clarifies the potential function of an entity in a biochemical or physical context. When it is used for ComponentDefinitions, it MUST identify terms from ontologies that are consistent with the types property of the ComponentDefinition. For example, the roles property of a DNA or RNA ComponentDefinition could contain URIs identifying terms from the Sequence Ontology (SO). It may be a product, genetic production, template, etc.

    2.1.4 Viewing a Component (Definition)

    Component (Definition) is used to represent biological design components such as DNA, RNA and small molecules. Once you’ve successfully navigated to the component’s home page, other than the parameters described in the general section, you’ll be able to view a few other parameters, which are described below.

    Just below the details table, you’ll be able to view a table titled, components, which has the following parameters:

    - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
    NameDescription
    AccessThe access property is a REQUIRED URI that indicates whether the ComponentInstance can be referred to remotely by a MapsTo on another ComponentInstance or Module contained by a different parent ComponentDefinition or ModuleDefinition (one that does not contain this ComponentInstance)
    InstanceThe ComponentInstance abstract class is inherited by SBOL classes that represent the usage or occurrence of a ComponentDefinition within a larger design (that is, another ComponentDefinition or ModuleDefinition).
    DefinitionThe definition property is a REQUIRED URI that refers to the ComponentDefinition of the ComponentInstance. As described in the previous section, this ComponentDefinition effectively provides information about the types and roles of the ComponentInstance.
    NameDescription
    AccessThe access property is a REQUIRED URI that indicates whether the ComponentInstance can be referred to remotely by a MapsTo on another ComponentInstance or Module contained by a different parent ComponentDefinition or ModuleDefinition (one that does not contain this ComponentInstance)
    InstanceThe ComponentInstance abstract class is inherited by SBOL classes that represent the usage or occurrence of a ComponentDefinition within a larger design (that is, another ComponentDefinition or ModuleDefinition).
    DefinitionThe definition property is a REQUIRED URI that refers to the ComponentDefinition of the ComponentInstance. As described in the previous section, this ComponentDefinition effectively provides information about the types and roles of the ComponentInstance.

    Below the components table is another table titled, sequence annotations, having the following attributes:

    - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
    NameDescription
    Sequence AnnotationsThe SequenceAnnotation class describes one or more regions of interest on the Sequence objects referred to by its parent ComponentDefinition. In addition, SequenceAnnotation objects can describe the substructure of their parent ComponentDefinition through association with the Component objects contained by this ComponentDefinition.
    LocationExtended by the Range, Cut, and GenericLocation classes.
    Components/Role1) Components: The components property is OPTIONAL and MAY specify a set of Component objects that are contained by the ComponentDefinition. The set of relations between Component and ComponentDefinition objects is strictly acyclic. 2) Role: Clarifies the potential function of an entity in a biochemical or physical context. When it is used for ComponentDefinitions, it MUST identify terms from ontologies that are consistent with the types property of the ComponentDefinition. For example, the roles property of a DNA or RNA ComponentDefinition could contain URIs identifying terms from the Sequence Ontology (SO).
    NameDescription
    Sequence AnnotationsThe SequenceAnnotation class describes one or more regions of interest on the Sequence objects referred to by its parent ComponentDefinition. In addition, SequenceAnnotation objects can describe the substructure of their parent ComponentDefinition through association with the Component objects contained by this ComponentDefinition.
    LocationExtended by the Range, Cut, and GenericLocation classes.
    Components/Role1) Components: The components property is OPTIONAL and MAY specify a set of Component objects that are contained by the ComponentDefinition. The set of relations between Component and ComponentDefinition objects is strictly acyclic. 2) Role: Clarifies the potential function of an entity in a biochemical or physical context. When it is used for ComponentDefinitions, it MUST identify terms from ontologies that are consistent with the types property of the ComponentDefinition. For example, the roles property of a DNA or RNA ComponentDefinition could contain URIs identifying terms from the Sequence Ontology (SO).

    2.1.5 Viewing a Sequence

    @@ -424,34 +427,34 @@

    2.2 Downloading the Information

    Following are the types of formats that you may be able to download a record:

    Note: Not all the record types may be downloaded in all formats.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology.
    Combine ArchiveA COMBINE archive is a single file containing the various documents (and in the future, references to documents), necessary for the description of a model and all associated data and procedures. This includes for instance, but not limited to, simulation experiment descriptions, all models needed to run the simulations and associated data files. The archive is encoded using the Open Modeling EXchange format (OMEX).
    GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines.
    FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics.
    ImageImage is a capture of the Visbol display at the top of the page.
    TypeDescription
    SBOLThe Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology.
    Combine ArchiveA COMBINE archive is a single file containing the various documents (and in the future, references to documents), necessary for the description of a model and all associated data and procedures. This includes for instance, but not limited to, simulation experiment descriptions, all models needed to run the simulations and associated data files. The archive is encoded using the Open Modeling EXchange format (OMEX).
    GFF3The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines.
    FASTAIn bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package, but has now become a near universal standard in the field of bioinformatics.
    ImageImage is a capture of the Visbol display at the top of the page.

    Additional download options may be available via the use of download plugins.

    @@ -468,24 +471,24 @@

    2.2 Downloading the Information

    - - + + - + - - - + + + - + - +