Difference between revisions of "Team:EPF Lausanne/Software"

Line 133: Line 133:
 
                       <td>ODEs Generator</td>
 
                       <td>ODEs Generator</td>
 
                       <td>Program generating automatically the ODEs governing our system from the circuit structure.</td>
 
                       <td>Program generating automatically the ODEs governing our system from the circuit structure.</td>
 +
                      <td></td>
 +
                  </tr>
 +
 +
                  <tr class='clickable-row' data-href='#ODEsolv'>
 +
                      <td>ODEs Solver</td>
 +
                      <td>Program solving a system of non-linear ODEs given an initial condition.</td>
 
                       <td></td>
 
                       <td></td>
 
                   </tr>
 
                   </tr>
Line 338: Line 344:
 
       <div class="col-md-12 col-centered">
 
       <div class="col-md-12 col-centered">
 
         <h2>ODE Generator</h2>
 
         <h2>ODE Generator</h2>
 +
 +
      </div>
 +
    </div>
 +
  </div>
 +
</div>
 +
 +
<a class="anchor" id="top" name='ODEsolv'></a>
 +
<div class="soft-section">
 +
  <div class="container">
 +
    <div class="row">
 +
      <div class="col-md-12 col-centered">
 +
        <h2>ODE Solver</h2>
 +
 +
        <p></p>
 +
 +
<div class="highlight"><pre><span class="kn">import</span> <span class="nn">numpy</span> <span class="kn">as</span> <span class="nn">np</span>
 +
<span class="kn">from</span> <span class="nn">scipy.integrate</span> <span class="kn">import</span> <span class="o">*</span>
 +
<span class="kn">import</span> <span class="nn">matplotlib.pylab</span> <span class="kn">as</span> <span class="nn">plt</span>
 +
 +
<span class="k">class</span> <span class="nc">Solver</span><span class="p">:</span>
 +
    <span class="sd">&quot;&quot;&quot;</span>
 +
<span class="sd">    Class that allows the solution of a system of non-linear ODEs. The system is specified by the function fun</span>
 +
 +
<span class="sd">        dy/dt = fun(t,y)</span>
 +
 +
<span class="sd">    where t is a number and y and dy/dt are numpy arrays or lists.</span>
 +
 +
<span class="sd">    The solution is performed with the dopri5 method, an explicit runge-kutta method of order (4)5.</span>
 +
<span class="sd">    The method is due to Dormand &amp; Prince, and is implemented by E. Hairer and G. Wanner.</span>
 +
 +
<span class="sd">    See</span>
 +
<span class="sd">        http://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.integrate.ode.html</span>
 +
<span class="sd">    for more details.</span>
 +
 +
<span class="sd">    NOTE:</span>
 +
<span class="sd">    Our Solver need a function of the type fun(t,y).</span>
 +
<span class="sd">    In cases where the fun takes additional arguments funArgs(t,y,arg1,...) it is possible to create an alias:</span>
 +
 +
<span class="sd">        fun = lambda t,y: funArgs(t,y,arg1,...)</span>
 +
 +
<span class="sd">    The additional arguments are now contained in the alias and fun is of the type fun(t,y).</span>
 +
<span class="sd">    &quot;&quot;&quot;</span>
 +
 +
    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">dt</span><span class="p">,</span><span class="n">fun</span><span class="p">,</span><span class="n">t0</span><span class="p">,</span><span class="n">T</span><span class="p">,</span><span class="n">y0</span><span class="p">):</span>
 +
        <span class="bp">self</span><span class="o">.</span><span class="n">dt</span> <span class="o">=</span> <span class="n">dt</span> <span class="c"># Time step</span>
 +
        <span class="bp">self</span><span class="o">.</span><span class="n">fun</span> <span class="o">=</span> <span class="n">fun</span> <span class="c"># Function representing the ODE</span>
 +
        <span class="bp">self</span><span class="o">.</span><span class="n">t0</span> <span class="o">=</span> <span class="n">t0</span> <span class="c"># Initial time</span>
 +
        <span class="bp">self</span><span class="o">.</span><span class="n">T</span> <span class="o">=</span> <span class="n">T</span> <span class="c"># Final time</span>
 +
        <span class="bp">self</span><span class="o">.</span><span class="n">y0</span> <span class="o">=</span> <span class="n">y0</span> <span class="c"># Initial condition</span>
 +
 +
    <span class="k">def</span> <span class="nf">solve</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 +
        <span class="sd">&quot;&quot;&quot;</span>
 +
<span class="sd">        Solve the system of ODEs</span>
 +
 +
<span class="sd">            dy/dt = fun(t,y)</span>
 +
 +
<span class="sd">        on the interval [t0,T], with the initial condition y(0)=y0.</span>
 +
 +
<span class="sd">        Returns two lists, solution and time, containing time points and the solution at these time points.</span>
 +
<span class="sd">        &quot;&quot;&quot;</span>
 +
 +
        <span class="c"># Choose integrator type: dopri5 in this case</span>
 +
        <span class="n">r</span> <span class="o">=</span> <span class="n">ode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fun</span><span class="p">)</span><span class="o">.</span><span class="n">set_integrator</span><span class="p">(</span><span class="s">&#39;dopri5&#39;</span><span class="p">)</span>
 +
 +
        <span class="c"># Initialize the integrator</span>
 +
        <span class="n">r</span><span class="o">.</span><span class="n">set_initial_value</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">y0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">t0</span><span class="p">)</span>
 +
 +
        <span class="c"># Initialize solution list and time points list</span>
 +
        <span class="n">solution</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">y0</span><span class="p">)</span>
 +
        <span class="n">time</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">t0</span><span class="p">)</span>
 +
 +
        <span class="k">while</span> <span class="n">r</span><span class="o">.</span><span class="n">successful</span><span class="p">()</span> <span class="ow">and</span> <span class="n">r</span><span class="o">.</span><span class="n">t</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">T</span><span class="p">:</span>
 +
            <span class="n">r</span><span class="o">.</span><span class="n">integrate</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">t</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">dt</span><span class="p">)</span> <span class="c"># Perform one integration step, i.e. obtain the solution y at time t+dt</span>
 +
 +
            <span class="n">time</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">time</span><span class="p">,</span><span class="n">r</span><span class="o">.</span><span class="n">t</span><span class="p">)</span> <span class="c"># Append the new time</span>
 +
            <span class="n">solution</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">vstack</span><span class="p">((</span><span class="n">solution</span><span class="p">,</span><span class="n">r</span><span class="o">.</span><span class="n">y</span><span class="p">))</span> <span class="c"># Append the new solution</span>
 +
 +
        <span class="k">return</span> <span class="n">time</span><span class="p">,</span> <span class="n">solution</span> <span class="c"># Return time and solution vectors</span>
 +
 +
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&quot;__main__&quot;</span><span class="p">:</span>
 +
    <span class="kn">from</span> <span class="nn">test</span> <span class="kn">import</span> <span class="o">*</span> <span class="c"># Import test functions for the ODE integrator</span>
 +
 +
    <span class="c"># Our test functions:</span>
 +
    <span class="c">#  rapid_equilibrium (standard function)</span>
 +
    <span class="c">#  rapid_equilibrium_from_string() (returns a function compiled from a string)</span>
 +
 +
    <span class="n">dt</span> <span class="o">=</span> <span class="mf">0.1</span>
 +
 +
    <span class="n">t0</span> <span class="o">=</span> <span class="mi">0</span>
 +
    <span class="n">T</span> <span class="o">=</span> <span class="mi">100</span>
 +
    <span class="n">y0</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">]</span>
 +
 +
    <span class="c"># Store the compiled function</span>
 +
    <span class="n">rapid_equilibrium_s</span> <span class="o">=</span> <span class="n">rapid_equilibrium_from_string</span><span class="p">()</span>
 +
 +
    <span class="n">mysolver</span> <span class="o">=</span> <span class="n">Solver</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span><span class="n">rapid_equilibrium</span><span class="p">,</span><span class="n">t0</span><span class="p">,</span><span class="n">T</span><span class="p">,</span><span class="n">y0</span><span class="p">)</span>
 +
    <span class="n">mysolver_string</span> <span class="o">=</span> <span class="n">Solver</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span><span class="n">rapid_equilibrium_s</span><span class="p">,</span><span class="n">t0</span><span class="p">,</span><span class="n">T</span><span class="p">,</span><span class="n">y0</span><span class="p">)</span>
 +
 +
    <span class="n">t</span><span class="p">,</span><span class="n">y</span> <span class="o">=</span> <span class="n">mysolver</span><span class="o">.</span><span class="n">solve</span><span class="p">()</span>
 +
    <span class="n">ts</span><span class="p">,</span><span class="n">ys</span> <span class="o">=</span> <span class="n">mysolver_string</span><span class="o">.</span><span class="n">solve</span><span class="p">()</span>
 +
 +
    <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">t</span><span class="p">,</span><span class="n">y</span><span class="p">)</span>
 +
    <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">ts</span><span class="p">,</span><span class="n">ys</span><span class="p">)</span>
 +
    <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 +
</pre></div>
  
 
       </div>
 
       </div>

Revision as of 09:40, 25 August 2015

EPFL 2015 iGEM bioLogic Logic Orthogonal gRNA Implemented Circuits EPFL 2015 iGEM bioLogic Logic Orthogonal gRNA Implemented Circuits

Software

Name Description
code2html Script creating automatically HTML and CSS code from source files in Python, C++ or BASH. Download
ODEs Generator Program generating automatically the ODEs governing our system from the circuit structure.
ODEs Solver Program solving a system of non-linear ODEs given an initial condition.

code2html

The following Python script allows to generate HTML (and CSS) code from source files in C++ and Python languages. It is based on Pygment, a Python syntax highlighter. All code in our Wiki is formatted using this script.

This script accepts two command line arguments: the first argument is the name of the file to convert, the second one (optional) is to ask separate HTML and CSS files.

"""
Command:

######################################

    python code2html INPUTFILE [CSS]

######################################

INPUTFILE: name (with path) of the file to convert to html
CSS: write "true" (ot "t", "yes", "y") in order to obtain separate .html and .css files ("false" by default)
"""

from pygments import highlight
from pygments.lexers import PythonLexer
from pygments.lexers import CppLexer
from pygments.lexers import BashLexer
from pygments.formatters import HtmlFormatter

# Code formatting style
style = "monokai"

# C++ extensions
cpp = ["cpp","cxx","cc","h"]

# Python extensions
py = ["py"]

# Bash extensions
bash = ["sh","bash"]

def load_file_as_sting(fname):
    """
    Open the file FNAME and save all its content in an unformatted string
    """

    content = ""

    with open(fname,'r') as f: # Open the file (read only)
        content = f.read() # Read file and store it in an unformatted string
        # The file is automatically closed

    return content

def save_string_as_file(fname,string):
    """
    Save the unformatted string STRING into the file FNAME
    """

    with open(fname,'w') as f: # Open the file (write only)
        f.write(string)
        # The file is automatically closed

def lexer_formatter(language,css=False):
    """
    Return the lexer for the appropriate language and the HTML formatter
    """

    L = None

    if language in py:
        # Python Lexer
        L = PythonLexer()

    elif language in cpp:
        # C++ Lexer
        L = CppLexer()

    elif language in bash:
        # Bash Lexer
        L = BashLexer()

    else:
        raise NameError("Invalid language.")

    HF = HtmlFormatter(full=not css,style=style)

    return L, HF


def code_to_htmlcss(code,language):
    """
    Transform CODE into html and css (separate files)
    """

    # Obtain lexer and HtmlFormatter
    L, HF = lexer_formatter(language,css=True)

    # Create html code
    html = highlight(code,L,HF)

    # Create css code
    css = HF.get_style_defs('.highlight')

    return html,css

def code_to_html(code,language):
    """
    Transform CODE into html and css (all in the same file)
    """

    # Obtain lexer and HtmlFormatter
    L, HF = lexer_formatter(language)

    # Create fill html code
    html = highlight(code,L,HF)

    return html

import sys

if __name__ == "__main__":
    """
    Command:

    ######################################

        python code2html INPUTFILE [CSS]

    ######################################

    INPUTFILE: name (with path) of the file to convert to html
    CSS: write "true" (ot "t", "yes", "y") in order to obtain separate .html and .css files ("false" by default)
    """

    # Command line arguments
    args = sys.argv

    # Check command line arguments
    ncla = len(args) # number of command line arguments

    if ncla != 2 and ncla != 3 :
        raise TypeError("Invalid number of command line arguments.")

    css_bool = False

    if ncla == 3 and args[-1].lower() in ["true",'t',"yes",'y']:
        css_bool = True # Export css separately

    # Input file
    fname_code = sys.argv[1] # Name of the file containing the code to convert in html

    # Input file extension
    language = fname_code.split('.')[-1]

    # Output files
    fname_html = fname_code.split('.')[0] + ".html" # Name of the file where the html code will be stored
    fname_css = fname_code.split('.')[0] + ".css" # Name of the file where the css code will be stored

    # Save code into a unformatted string
    code = load_file_as_sting(fname_code)

    if css_bool == False: # Convert to standalone html
        html = code_to_html(code,language)
    else: # Convert to html and css separately
        html,css = code_to_htmlcss(code,language)

    # Save html
    save_string_as_file(fname_html,html)

    if css_bool == True:
        # Save css
        save_string_as_file(fname_css,css)

ODE Generator

ODE Solver

import numpy as np
from scipy.integrate import *
import matplotlib.pylab as plt

class Solver:
    """
    Class that allows the solution of a system of non-linear ODEs. The system is specified by the function fun

        dy/dt = fun(t,y)

    where t is a number and y and dy/dt are numpy arrays or lists.

    The solution is performed with the dopri5 method, an explicit runge-kutta method of order (4)5.
    The method is due to Dormand & Prince, and is implemented by E. Hairer and G. Wanner.

    See
        http://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.integrate.ode.html
    for more details.

    NOTE:
    Our Solver need a function of the type fun(t,y).
    In cases where the fun takes additional arguments funArgs(t,y,arg1,...) it is possible to create an alias:

        fun = lambda t,y: funArgs(t,y,arg1,...)

    The additional arguments are now contained in the alias and fun is of the type fun(t,y).
    """

    def __init__(self,dt,fun,t0,T,y0):
        self.dt = dt # Time step
        self.fun = fun # Function representing the ODE
        self.t0 = t0 # Initial time
        self.T = T # Final time
        self.y0 = y0 # Initial condition

    def solve(self):
        """
        Solve the system of ODEs

            dy/dt = fun(t,y)

        on the interval [t0,T], with the initial condition y(0)=y0.

        Returns two lists, solution and time, containing time points and the solution at these time points.
        """

        # Choose integrator type: dopri5 in this case
        r = ode(self.fun).set_integrator('dopri5')

        # Initialize the integrator
        r.set_initial_value(self.y0, self.t0)

        # Initialize solution list and time points list
        solution = np.asarray(self.y0)
        time = np.asarray(self.t0)

        while r.successful() and r.t < self.T:
            r.integrate(r.t + self.dt) # Perform one integration step, i.e. obtain the solution y at time t+dt

            time = np.append(time,r.t) # Append the new time
            solution = np.vstack((solution,r.y)) # Append the new solution

        return time, solution # Return time and solution vectors

if __name__ == "__main__":
    from test import * # Import test functions for the ODE integrator

    # Our test functions:
    #   rapid_equilibrium (standard function)
    #   rapid_equilibrium_from_string() (returns a function compiled from a string)

    dt = 0.1

    t0 = 0
    T = 100
    y0 = [1,0,0]

    # Store the compiled function
    rapid_equilibrium_s = rapid_equilibrium_from_string()

    mysolver = Solver(dt,rapid_equilibrium,t0,T,y0)
    mysolver_string = Solver(dt,rapid_equilibrium_s,t0,T,y0)

    t,y = mysolver.solve()
    ts,ys = mysolver_string.solve()

    plt.plot(t,y)
    plt.plot(ts,ys)
    plt.show()
EPFL 2015 iGEM bioLogic Logic Orthogonal gRNA Implemented Circuits

NOT PROOFREAD