Main Content

sbiowhos

Show contents of project file, library file, or SimBiology root object

Description

sbiowhos shows contents of the SimBiology® Root object. This includes all the built-in and user-defined kinetic laws, units, and unit prefixes. This syntax is equivalent to calling the function by specifying all the available flags as shown in the next syntax.

example

sbiowhos(flagOrFileName) specifies one or more flags or file names to show the corresponding information about the root object or shows the contents of specified SimBiology project or library files.

example

sbiowhos flagOrFileName is the command form of the syntax. Command form requires fewer special characters. You do not need to type parentheses or enclose the input in single or double quotes. Separate inputs with spaces instead of commas. If any input includes spaces, enclose it in single quotes.

example

Examples

collapse all

Display a list of built-in kinetic laws, units, and unit prefixes.

sbiowhos("-builtin")
vectall = 
   SimBiology Abstract Kinetic Law Array

   Index:    Library:    Name:                                Expression:                                       
   1         BuiltIn     Unknown                              Unknown                                           
   2         BuiltIn     MassAction                           MassAction                                        
   3         BuiltIn     Henri-Michaelis-Menten               Vm*S/(Km + S)                                     
   4         BuiltIn     Henri-Michaelis-Menten-Reversible    (Vmf*S/Ks - Vmr*P/Kp)/(1 + S/Ks + P/Kp)           
   5         BuiltIn     Hill-Kinetics                        Vm*S^n/(Kp + S^n)                                 
   6         BuiltIn     Iso-Uni-Uni                          Vmf*(S - P/Keq)/(Kms*(1 + P/Kmp) + S*(1 + P/Kiip))
   7         BuiltIn     Ordered-Bi-Bi                        Vm/((Ksa*Kmb/(A*B)) + (Kma/A) + (Kmb/B) + 1)      
   8         BuiltIn     Ping-Pong-Bi-Bi                      Vm/((Kma/A) + (Kmb/B) + 1)                        
   9         BuiltIn     Competitive-Inhibition               Vm*S/(Km*(1 + I/Ki) + S)                          
   10        BuiltIn     NonCompetitive-Inhibition            Vm*S/((Ks + S)*(1 + I/Ki))                        
   11        BuiltIn     UnCompetitive-Inhibition             Vm*S/(Km + S*(1 + I/Ki))                          

   SimBiology Built-In Units

   Index:  Name:           Composition:             Multiplier:     
   1       acre            foot^2                   43560.000000    
   2       ampere          ampere                   1.000000        
   3       ares            meter^2                  100.000000      
   4       becquerel       1/second                 1.000000        
   5       biot            biot                     1.000000        
   6       calorie         [1x27 char]              4.186800        
   7       candela         candela                  1.000000        
   8       candle          candle                   1.000000        
   9       coulomb         ampere*second            1.000000        
   10      day             day                      1.000000        
   11      dimensionless   dimensionless            1.000000        
   12      dyne            [1x26 char]              1.000000        
   13      farad           [1x38 char]              1.000000        
   14      foot            foot                     1.000000        
   15      gallon          inch^3                   231.000000      
   16      gram            gram                     1.000000        
   17      gray            meter^2/second^2         1.000000        
   18      henry           [1x38 char]              1.000000        
   19      hertz           1/second                 1.000000        
   20      hour            hour                     1.000000        
   21      inch            inch                     1.000000        
   22      item            item                     1.000000        
   23      joule           [1x27 char]              1.000000        
   24      katal           mole/second              1.000000        
   25      kelvin          kelvin                   1.000000        
   26      liter           decimeter^3              1.000000        
   27      litre           decimeter^3              1.000000        
   28      meter           meter                    1.000000        
   29      metre           metre                    1.000000        
   30      mile            mile                     1.000000        
   31      minute          minute                   1.000000        
   32      molarity        mole/liter               1.000000        
   33      mole            mole                     1.000000        
   34      molecule        molecule                 1.000000        
   35      newton          [1x25 char]              1.000000        
   36      ohm             [1x38 char]              1.000000        
   37      ounce           ounce                    1.000000        
   38      pascal          [1x25 char]              1.000000        
   39      pint            inch^3                   28.875000       
   40      pound           pound                    1.000000        
   41      pound_force     (pound*foot)/second^2    32.174049       
   42      quart           inch^3                   57.750000       
   43      second          second                   1.000000        
   44      siemens         [1x38 char]              1.000000        
   45      sievert         meter^2/second^2         1.000000        
   46      tesla           [1x26 char]              1.000000        
   47      ton             ton                      1.000000        
   48      volt            [1x36 char]              1.000000        
   49      watt            [1x27 char]              1.000000        
   50      weber           [1x36 char]              1.000000        
   51      week            week                     1.000000        
   52      yard            yard                     1.000000        
   53      year            year                     1.000000        

   SimBiology Built-In Unit Prefixes

   Index:  Name:           Multiplier:              
   1       centi           0.01                     
   2       deci            0.1                      
   3       deka            10                       
   4       femto           1e-15                    
   5       giga            1e+09                    
   6       hecto           100                      
   7       kilo            1000                     
   8       mega            1e+06                    
   9       micro           1e-06                    
   10      milli           0.001                    
   11      nano            1e-09                    
   12      pico            1e-12                    
   13      tera            1e+12                    

Show only the built-in units.

sbiowhos("-builtin","-unit")
   SimBiology Built-In Units

   Index:  Name:           Composition:             Multiplier:     
   1       acre            foot^2                   43560.000000    
   2       ampere          ampere                   1.000000        
   3       ares            meter^2                  100.000000      
   4       becquerel       1/second                 1.000000        
   5       biot            biot                     1.000000        
   6       calorie         [1x27 char]              4.186800        
   7       candela         candela                  1.000000        
   8       candle          candle                   1.000000        
   9       coulomb         ampere*second            1.000000        
   10      day             day                      1.000000        
   11      dimensionless   dimensionless            1.000000        
   12      dyne            [1x26 char]              1.000000        
   13      farad           [1x38 char]              1.000000        
   14      foot            foot                     1.000000        
   15      gallon          inch^3                   231.000000      
   16      gram            gram                     1.000000        
   17      gray            meter^2/second^2         1.000000        
   18      henry           [1x38 char]              1.000000        
   19      hertz           1/second                 1.000000        
   20      hour            hour                     1.000000        
   21      inch            inch                     1.000000        
   22      item            item                     1.000000        
   23      joule           [1x27 char]              1.000000        
   24      katal           mole/second              1.000000        
   25      kelvin          kelvin                   1.000000        
   26      liter           decimeter^3              1.000000        
   27      litre           decimeter^3              1.000000        
   28      meter           meter                    1.000000        
   29      metre           metre                    1.000000        
   30      mile            mile                     1.000000        
   31      minute          minute                   1.000000        
   32      molarity        mole/liter               1.000000        
   33      mole            mole                     1.000000        
   34      molecule        molecule                 1.000000        
   35      newton          [1x25 char]              1.000000        
   36      ohm             [1x38 char]              1.000000        
   37      ounce           ounce                    1.000000        
   38      pascal          [1x25 char]              1.000000        
   39      pint            inch^3                   28.875000       
   40      pound           pound                    1.000000        
   41      pound_force     (pound*foot)/second^2    32.174049       
   42      quart           inch^3                   57.750000       
   43      second          second                   1.000000        
   44      siemens         [1x38 char]              1.000000        
   45      sievert         meter^2/second^2         1.000000        
   46      tesla           [1x26 char]              1.000000        
   47      ton             ton                      1.000000        
   48      volt            [1x36 char]              1.000000        
   49      watt            [1x27 char]              1.000000        
   50      weber           [1x36 char]              1.000000        
   51      week            week                     1.000000        
   52      yard            yard                     1.000000        
   53      year            year                     1.000000        

You can also use the command form of the syntax.

sbiowhos -builtin -unitprefix
   SimBiology Built-In Unit Prefixes

   Index:  Name:           Multiplier:              
   1       centi           0.01                     
   2       deci            0.1                      
   3       deka            10                       
   4       femto           1e-15                    
   5       giga            1e+09                    
   6       hecto           100                      
   7       kilo            1000                     
   8       mega            1e+06                    
   9       micro           1e-06                    
   10      milli           0.001                    
   11      nano            1e-09                    
   12      pico            1e-12                    
   13      tera            1e+12                    

Create a unit prefix peta with the exponent value of 15.

petaPrefix = sbiounitprefix("peta",15);

Add the unit prefix to the library.

sbioaddtolibrary(petaPrefix);

Check that peta has been added as a user-defined unit prefix.

sbiowhos -userdefined -unitprefix
   SimBiology UserDefined Unit Prefixes
           
   Index:  Name:           Multiplier:              
   1       peta            1000000000000000         

You can also use sbioshowunitprefixes or the root object.

sbioshowunitprefixes
ans = 
   SimBiology Unit Prefix Array

   Index:    Library:       Name:    Exponent:
   1         BuiltIn        centi    -2       
   2         BuiltIn        deci     -1       
   3         BuiltIn        deka     1        
   4         BuiltIn        femto    -15      
   5         BuiltIn        giga     9        
   6         BuiltIn        hecto    2        
   7         BuiltIn        kilo     3        
   8         BuiltIn        mega     6        
   9         BuiltIn        micro    -6       
   10        BuiltIn        milli    -3       
   11        BuiltIn        nano     -9       
   12        UserDefined    peta     15       
   13        BuiltIn        pico     -12      
   14        BuiltIn        tera     12       

rootObj = sbioroot;
rootObj.UserDefinedLibrary.UnitPrefixes
ans = 
   SimBiology Unit Prefix Array

   Index:    Library:       Name:    Exponent:
   1         UserDefined    peta     15       

Input Arguments

collapse all

Flag or file name, specified as a character vector or string scalar. You can specify one or more flags or file names.

If you specify flags only, the function shows the corresponding information about the SimBiology root object, such as built-in kinetic laws, units, and so on. If you specify file names only, the function shows information about the specified files. If you specify a combination of flags and file names, the function shows the specified flag information from the files.

Valid flags are as follows:

FlagDescription
-builtin Built-in kinetic laws, units, and unit prefixes
-data Data saved in file
-kineticlaw Built-in and user-defined kinetic laws
-unitBuilt-in and user-defined units
-unitprefix Built-in and user-defined unit prefixes
-userdefined User-defined kinetic laws, units, and unit prefixes

Valid file types are as follows.

File TypeDescription
SBPROJSimBiology project files, created with sbiosaveproject or with SimBiology apps
SBKLIBKinetic law library files, created with sbiocopylibrary
SBULIBUnit and unit prefix library files, created with sbiocopylibrary

Example: sbiowhos("-builtin","-unit")

Data Types: char | string

Version History

Introduced in R2006a

expand all