Commit 3b45301e authored by Documenter.jl's avatar Documenter.jl
Browse files

build based on 2c517b3b

parent 4c20f321
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 24.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 79 77.5" style="enable-background:new 0 0 79 77.5;" xml:space="preserve">
<style type="text/css">
.st0{fill:url(#SVGID_1_);}
.st1{fill:#CB3E32;}
.st2{fill:#935AA3;}
.st3{fill:#3A9746;}
</style>
<radialGradient id="SVGID_1_" cx="-45.4331" cy="60.0468" r="61.6" gradientTransform="matrix(1.0199 0 0 -0.9999 80.1193 89.3446)" gradientUnits="userSpaceOnUse">
<stop offset="0" style="stop-color:#BDE7FB"/>
<stop offset="4.000000e-02" style="stop-color:#B9E5FB"/>
<stop offset="9.000000e-02" style="stop-color:#AAE0FA"/>
<stop offset="0.15" style="stop-color:#90D9F8"/>
<stop offset="0.21" style="stop-color:#6ECFF5"/>
<stop offset="0.21" style="stop-color:#6CCFF6"/>
<stop offset="0.31" style="stop-color:#67CAF3"/>
<stop offset="0.43" style="stop-color:#58BDEC"/>
<stop offset="0.56" style="stop-color:#3DA7DD"/>
<stop offset="0.7" style="stop-color:#1D89CA"/>
<stop offset="0.79" style="stop-color:#0D73BB"/>
<stop offset="1" style="stop-color:#0756A5"/>
</radialGradient>
<path class="st0" d="M74,39.3c-0.1-1.6,0.4-3.3,1.4-4.6c3-4.1,4.2-9.2,3.3-14.1c-2-10.5-10.1-18.3-21-20.2c-4.5-0.8-9.2,0-13.2,2.3
c-4,2.4-8.3,7.8-8.3,16.8c0,4.7-1.2,8.5-3.9,11.4c-2.9,2.5-6.6,3.8-10.4,3.8c-8.3,0-12.6-6.4-11.7-12.9c1.3-7.2,7.1-12.6,14.3-13.5
c2.3-0.2,4.7,0.1,6.9,0.9c1.4,0.6,3,0,3.7-1.4c1.1-1.6,0.9-4.2-2.3-5.8c-3.6-1.7-7.6-2.2-11.5-1.4c-10.9,1.9-19,9.7-21,20.2
c-0.9,5,0.3,10.1,3.3,14.1c4.5,6.3,11.5,8.1,15.8,8.9c9.5,1.8,13.7,7,14.2,14.3c0.3,7.3-5.1,11.2-11.4,10.1
C15.9,66.9,11,61.9,9.8,55.5c-0.4-2.5,0-5.2,1.2-7.4c0.6-1.2-0.4-2.7-2.4-3.8c-2-1.1-4.1-1.5-5-0.3c-2.4,3.3-3.4,8.3-2.4,13.2
c2.2,10,10.2,17.8,20.3,19.8c4.8,0.9,8.5,0,13-2c2.6-1.1,6.7-1,10,0.4c4,1.9,8.5,2.6,12.9,2c10.7-1.9,18.8-9.4,21-19.8
c0.8-4.7-0.2-9.6-2.9-13.6C74.5,42.6,74,40.9,74,39.3z M69.6,55.6c-1.1,6.9-6.6,12.2-13.6,13c-7,0.8-12.9-3.6-13-11.1
c0.2-7.5,7-14.1,14.9-14.4C65.7,43,70.4,48.8,69.6,55.6L69.6,55.6z M59.7,32.1c-7.8-0.3-14.6-6.9-14.9-14.3
c-0.1-7.3,5.9-11.6,12.9-10.9C64.5,7.8,70,13,71.2,19.8C72.1,26.5,67.5,32.2,59.7,32.1z"/>
<g id="g890">
<path id="path13" class="st1" d="M21.8,65c-4.9,0-8.9-4-8.9-8.9c0-4.9,4-8.9,8.9-8.9c4.9,0,8.9,4,8.9,8.9C30.7,61,26.7,65,21.8,65z
"/>
<path id="path25" class="st2" d="M58,28.4c-4.9,0-8.9-4-8.9-8.9c0-4.9,4-8.9,8.9-8.9c4.9,0,8.9,4,8.9,8.9C67,24.4,63,28.4,58,28.4z
"/>
<path id="path31" class="st3" d="M56.4,64.8c-4.9,0-8.9-4-8.9-8.9c0-4.9,4-8.9,8.9-8.9c4.9,0,8.9,4,8.9,8.9
C65.3,60.8,61.3,64.8,56.4,64.8C56.4,64.8,56.4,64.8,56.4,64.8z"/>
</g>
</svg>
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Documentation · SBML.jl</title><link rel="canonical" href="https://lcsb-biocore.github.io/DistributedData.jl/stable/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">SBML.jl</span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Documentation</a><ul class="internal"><li><a class="tocitem" href="#Functions"><span>Functions</span></a></li><li><a class="tocitem" href="#Data-helpers"><span>Data helpers</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Documentation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Documentation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/LCSB-BioCore/SBML.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="SBML.jl-—-load-systems-biology-models-from-SBML-files"><a class="docs-heading-anchor" href="#SBML.jl-—-load-systems-biology-models-from-SBML-files">SBML.jl — load systems biology models from SBML files</a><a id="SBML.jl-—-load-systems-biology-models-from-SBML-files-1"></a><a class="docs-heading-anchor-permalink" href="#SBML.jl-—-load-systems-biology-models-from-SBML-files" title="Permalink"></a></h1><p>This package provides a straightforward way to load model- and simulation-relevant information from SBML files.</p><p>The library provides a single function <a href="#SBML.readSBML-Tuple{String}"><code>readSBML</code></a> to load a <a href="#SBML.Model"><code>Model</code></a>:</p><pre><code class="language-julia">julia&gt; using SBML
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Documentation · SBML.jl</title><link rel="canonical" href="https://lcsb-biocore.github.io/DistributedData.jl/stable/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.svg" alt="SBML.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit">SBML.jl</span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Documentation</a><ul class="internal"><li><a class="tocitem" href="#Functions"><span>Functions</span></a></li><li><a class="tocitem" href="#Data-helpers"><span>Data helpers</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Documentation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Documentation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/LCSB-BioCore/SBML.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="SBML.jl-—-load-systems-biology-models-from-SBML-files"><a class="docs-heading-anchor" href="#SBML.jl-—-load-systems-biology-models-from-SBML-files">SBML.jl — load systems biology models from SBML files</a><a id="SBML.jl-—-load-systems-biology-models-from-SBML-files-1"></a><a class="docs-heading-anchor-permalink" href="#SBML.jl-—-load-systems-biology-models-from-SBML-files" title="Permalink"></a></h1><p>This package provides a straightforward way to load model- and simulation-relevant information from SBML files.</p><p>The library provides a single function <a href="#SBML.readSBML-Tuple{String}"><code>readSBML</code></a> to load a <a href="#SBML.Model"><code>Model</code></a>:</p><pre><code class="language-julia">julia&gt; using SBML
julia&gt; mdl = readSBML(&quot;Ec_core_flux1.xml&quot;)
Model(…)
......@@ -26,7 +26,7 @@ julia&gt; S
0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 -1.0 0.0 0.0 0.0 0.0 0.0
⋮ ⋮ ⋱ ⋮ ⋮ </code></pre><h2 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h2><h3 id="Data-structures"><a class="docs-heading-anchor" href="#Data-structures">Data structures</a><a id="Data-structures-1"></a><a class="docs-heading-anchor-permalink" href="#Data-structures" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="SBML.Model" href="#SBML.Model"><code>SBML.Model</code></a><span class="docstring-category">Type</span></header><section><div><p>Structure that collects the model-related data. Contains <code>units</code>, <code>compartments</code>, <code>species</code> and <code>reactions</code>. The contained dictionaries are indexed by identifiers of the corresponding objects.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/structs.jl#L47-L51">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.Reaction" href="#SBML.Reaction"><code>SBML.Reaction</code></a><span class="docstring-category">Type</span></header><section><div><p>Reaction with stoichiometry that assigns reactants and products their relative consumption/production rates (accessible in field <code>stoichiometry</code>), lower/upper bounds (in tuples <code>lb</code> and <code>ub</code>, with unit names), and objective coefficient (<code>oc</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/structs.jl#L23-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.Species" href="#SBML.Species"><code>SBML.Species</code></a><span class="docstring-category">Type</span></header><section><div><p>Species metadata – contains a human-readable <code>name</code>, and a <code>compartment</code> identifier</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/structs.jl#L37-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.UnitPart" href="#SBML.UnitPart"><code>SBML.UnitPart</code></a><span class="docstring-category">Type</span></header><section><div><p>Part of a measurement unit definition that corresponds to the SBML definition of <code>Unit</code>. For example, the unit &quot;per square megahour&quot;, Mh^(-2), is written as:</p><pre><code class="language-none">UnitPart(&quot;second&quot;, # base SI unit, this says we are measuring time
⋮ ⋮ ⋱ ⋮ ⋮ </code></pre><h2 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h2><h3 id="Data-structures"><a class="docs-heading-anchor" href="#Data-structures">Data structures</a><a id="Data-structures-1"></a><a class="docs-heading-anchor-permalink" href="#Data-structures" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="SBML.Model" href="#SBML.Model"><code>SBML.Model</code></a><span class="docstring-category">Type</span></header><section><div><p>Structure that collects the model-related data. Contains <code>units</code>, <code>compartments</code>, <code>species</code> and <code>reactions</code>. The contained dictionaries are indexed by identifiers of the corresponding objects.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/structs.jl#L47-L51">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.Reaction" href="#SBML.Reaction"><code>SBML.Reaction</code></a><span class="docstring-category">Type</span></header><section><div><p>Reaction with stoichiometry that assigns reactants and products their relative consumption/production rates (accessible in field <code>stoichiometry</code>), lower/upper bounds (in tuples <code>lb</code> and <code>ub</code>, with unit names), and objective coefficient (<code>oc</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/structs.jl#L23-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.Species" href="#SBML.Species"><code>SBML.Species</code></a><span class="docstring-category">Type</span></header><section><div><p>Species metadata – contains a human-readable <code>name</code>, and a <code>compartment</code> identifier</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/structs.jl#L37-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.UnitPart" href="#SBML.UnitPart"><code>SBML.UnitPart</code></a><span class="docstring-category">Type</span></header><section><div><p>Part of a measurement unit definition that corresponds to the SBML definition of <code>Unit</code>. For example, the unit &quot;per square megahour&quot;, Mh^(-2), is written as:</p><pre><code class="language-none">UnitPart(&quot;second&quot;, # base SI unit, this says we are measuring time
-2, # exponent, says &quot;per square&quot;
6, # log-10 scale of the unit, says &quot;mega&quot;
1/3600) # second-to-hour multiplier</code></pre><p>Compound units (such as &quot;volt-amperes&quot; and &quot;dozens of yards per ounce&quot;) are built from multiple <code>UnitPart</code>s; see the definition of field <code>units</code> in <a href="#SBML.Model"><code>Model</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/structs.jl#L2-L14">source</a></section></article><h3 id="Base-functions"><a class="docs-heading-anchor" href="#Base-functions">Base functions</a><a id="Base-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Base-functions" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="SBML.SBMLVersion-Tuple{}" href="#SBML.SBMLVersion-Tuple{}"><code>SBML.SBMLVersion</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function SBMLVersion()</code></pre><p>Get the version of the used SBML library in Julia version format.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/version.jl#L2-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.readSBML-Tuple{String}" href="#SBML.readSBML-Tuple{String}"><code>SBML.readSBML</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function readSBML(fn::String)::Model</code></pre><p>Read the SBML from a XML file in <code>fn</code> and return the contained <code>Model</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/readsbml.jl#L4-L8">source</a></section></article><h2 id="Data-helpers"><a class="docs-heading-anchor" href="#Data-helpers">Data helpers</a><a id="Data-helpers-1"></a><a class="docs-heading-anchor-permalink" href="#Data-helpers" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="SBML.getLBs-Tuple{Model}" href="#SBML.getLBs-Tuple{Model}"><code>SBML.getLBs</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getLBs(m::Model)::Vector{Tuple{Float64,String}}</code></pre><p>Extract a vector of lower bounds of reaction rates from the model. All bounds are accompanied with the unit of the corresponding value (this behavior is based on SBML specification).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/utils.jl#L20-L26">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.getOCs-Tuple{Model}" href="#SBML.getOCs-Tuple{Model}"><code>SBML.getOCs</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getOCs(m::Model)::Vector{Float64}</code></pre><p>Extract the vector of objective coefficients of each reaction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/utils.jl#L40-L44">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.getS-Tuple{Model}" href="#SBML.getS-Tuple{Model}"><code>SBML.getS</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getS(m::Model)::Tuple{Vector{String},Vector{String},Matrix{Float64}}</code></pre><p>Extract the vector of species (aka metabolite) identifiers, vector of reaction identifiers, and the (dense) stoichiometry matrix from an existing <code>Model</code>. Returns a tuple with these values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/utils.jl#L1-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.getUBs-Tuple{Model}" href="#SBML.getUBs-Tuple{Model}"><code>SBML.getUBs</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getUBs(m::Model)::Vector{Tuple{Float64,String}}</code></pre><p>Likewise to <code>getLBs</code>, extract the upper bounds.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/b584f62eb00322633a1314a6319c0c2fea3f229e/src/utils.jl#L31-L35">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 9 February 2021 09:23">Tuesday 9 February 2021</span>. Using Julia version 1.5.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
1/3600) # second-to-hour multiplier</code></pre><p>Compound units (such as &quot;volt-amperes&quot; and &quot;dozens of yards per ounce&quot;) are built from multiple <code>UnitPart</code>s; see the definition of field <code>units</code> in <a href="#SBML.Model"><code>Model</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/structs.jl#L2-L14">source</a></section></article><h3 id="Base-functions"><a class="docs-heading-anchor" href="#Base-functions">Base functions</a><a id="Base-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Base-functions" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="SBML.SBMLVersion-Tuple{}" href="#SBML.SBMLVersion-Tuple{}"><code>SBML.SBMLVersion</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function SBMLVersion()</code></pre><p>Get the version of the used SBML library in Julia version format.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/version.jl#L2-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.readSBML-Tuple{String}" href="#SBML.readSBML-Tuple{String}"><code>SBML.readSBML</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function readSBML(fn::String)::Model</code></pre><p>Read the SBML from a XML file in <code>fn</code> and return the contained <code>Model</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/readsbml.jl#L4-L8">source</a></section></article><h2 id="Data-helpers"><a class="docs-heading-anchor" href="#Data-helpers">Data helpers</a><a id="Data-helpers-1"></a><a class="docs-heading-anchor-permalink" href="#Data-helpers" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="SBML.getLBs-Tuple{Model}" href="#SBML.getLBs-Tuple{Model}"><code>SBML.getLBs</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getLBs(m::Model)::Vector{Tuple{Float64,String}}</code></pre><p>Extract a vector of lower bounds of reaction rates from the model. All bounds are accompanied with the unit of the corresponding value (this behavior is based on SBML specification).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/utils.jl#L20-L26">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.getOCs-Tuple{Model}" href="#SBML.getOCs-Tuple{Model}"><code>SBML.getOCs</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getOCs(m::Model)::Vector{Float64}</code></pre><p>Extract the vector of objective coefficients of each reaction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/utils.jl#L40-L44">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.getS-Tuple{Model}" href="#SBML.getS-Tuple{Model}"><code>SBML.getS</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getS(m::Model)::Tuple{Vector{String},Vector{String},Matrix{Float64}}</code></pre><p>Extract the vector of species (aka metabolite) identifiers, vector of reaction identifiers, and the (dense) stoichiometry matrix from an existing <code>Model</code>. Returns a tuple with these values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/utils.jl#L1-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SBML.getUBs-Tuple{Model}" href="#SBML.getUBs-Tuple{Model}"><code>SBML.getUBs</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">function getUBs(m::Model)::Vector{Tuple{Float64,String}}</code></pre><p>Likewise to <code>getLBs</code>, extract the upper bounds.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LCSB-BioCore/SBML.jl/blob/2c517b3b5f4fa09aed0cd73f74de076af48585ce/src/utils.jl#L31-L35">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 9 February 2021 10:36">Tuesday 9 February 2021</span>. Using Julia version 1.5.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · SBML.jl</title><link rel="canonical" href="https://lcsb-biocore.github.io/DistributedData.jl/stable/search/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">SBML.jl</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 9 February 2021 09:23">Tuesday 9 February 2021</span>. Using Julia version 1.5.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · SBML.jl</title><link rel="canonical" href="https://lcsb-biocore.github.io/DistributedData.jl/stable/search/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SBML.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit">SBML.jl</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 9 February 2021 10:36">Tuesday 9 February 2021</span>. Using Julia version 1.5.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment