Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@arnaou
arnaou committed Oct 27, 2024
1 parent 8e7568d commit 7353072
Show file tree
Hide file tree
Showing 14 changed files with 132 additions and 70 deletions.
24 changes: 15 additions & 9 deletions WS1/0_python_basics/0_python_basics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Introduction to Python &#8212; Dig4Bio-workshops</title>
<title>1. Introduction to Python &#8212; Dig4Bio-workshops</title>



Expand Down Expand Up @@ -57,10 +57,12 @@
<script async="async" src="../../_static/sphinx-thebe.js?v=c100c467"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>const THEBE_JS_URL = "https://unpkg.com/[email protected]/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'WS1/0_python_basics/0_python_basics';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Hello, World!" href="1_hello_world.html" />
<link rel="next" title="2. Hello, World!" href="1_hello_world.html" />
<link rel="prev" title="Introduction to Python" href="../intro_to_ws1.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -182,10 +184,12 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Introduction to Python (WS1)</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../intro_to_ws1.html">Introduction to workshop 1</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Python Basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="1_hello_world.html">Hello World</a></li>
<li class="toctree-l1"><a class="reference internal" href="2_statements.html">Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="3_control_flow.html">Control flow</a></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Module 1</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="1_hello_world.html">Hello World</a></li>
<li class="toctree-l2"><a class="reference internal" href="2_statements.html">Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="3_control_flow.html">Control flow</a></li>
</ul>
</details></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Model-based Techniques (WS2)</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -410,7 +414,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Introduction to Python</h1>
<h1>1. Introduction to Python</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand Down Expand Up @@ -438,7 +442,7 @@ <h2> Contents </h2>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="introduction-to-python">
<h1>Introduction to Python<a class="headerlink" href="#introduction-to-python" title="Link to this heading">#</a></h1>
<h1>1. Introduction to Python<a class="headerlink" href="#introduction-to-python" title="Link to this heading">#</a></h1>
<section id="objective">
<h2>Objective<a class="headerlink" href="#objective" title="Link to this heading">#</a></h2>
<p>This is a practical course designed for chemical engineers that want to learn how to program in Python.
Expand Down Expand Up @@ -505,6 +509,8 @@ <h2>Helpful tips and tricks before starting<a class="headerlink" href="#helpful-
<p>this course has been taken and adapted from The course <a class="reference external" href="https://github.com/FiammettaC/Chemical-Reaction-Engineering-in-Python"><em>Chemical Reaction engineering in Python</em></a> by Fiammetta Caccavale.</p>
</div>
</section>
<div class="toctree-wrapper compound">
</div>
</section>

<script type="text/x-thebe-config">
Expand Down Expand Up @@ -551,7 +557,7 @@ <h2>Helpful tips and tricks before starting<a class="headerlink" href="#helpful-
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Hello, World!</p>
<p class="prev-next-title">2. Hello, World!</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
24 changes: 13 additions & 11 deletions WS1/0_python_basics/1_hello_world.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Hello, World! &#8212; Dig4Bio-workshops</title>
<title>2. Hello, World! &#8212; Dig4Bio-workshops</title>



Expand Down Expand Up @@ -60,8 +60,8 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'WS1/0_python_basics/1_hello_world';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Statements and Packaging" href="2_statements.html" />
<link rel="prev" title="Introduction to Python" href="0_python_basics.html" />
<link rel="next" title="3. Statements and Packaging" href="2_statements.html" />
<link rel="prev" title="1. Introduction to Python" href="0_python_basics.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -182,10 +182,12 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Introduction to Python (WS1)</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../intro_to_ws1.html">Introduction to workshop 1</a></li>
<li class="toctree-l1"><a class="reference internal" href="0_python_basics.html">Python Basics</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Hello World</a></li>
<li class="toctree-l1"><a class="reference internal" href="2_statements.html">Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="3_control_flow.html">Control flow</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="0_python_basics.html">Module 1</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Hello World</a></li>
<li class="toctree-l2"><a class="reference internal" href="2_statements.html">Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="3_control_flow.html">Control flow</a></li>
</ul>
</details></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Model-based Techniques (WS2)</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -410,7 +412,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Hello, World!</h1>
<h1>2. Hello, World!</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand Down Expand Up @@ -439,7 +441,7 @@ <h2> Contents </h2>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="hello-world">
<h1>Hello, World!<a class="headerlink" href="#hello-world" title="Link to this heading">#</a></h1>
<h1>2. Hello, World!<a class="headerlink" href="#hello-world" title="Link to this heading">#</a></h1>
<p>Traditionally, Hello World programs are used to illustrate how coding works, as well as to verify that the system is operating correctly.
Greeting the user is considered the first step in learning to code, and it even has its own Wikipedia page!
So, let’s do that.</p>
Expand Down Expand Up @@ -661,15 +663,15 @@ <h2>“A Foolish Consistency is the Hobgoblin of Little Minds”<a class="header
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Introduction to Python</p>
<p class="prev-next-title">1. Introduction to Python</p>
</div>
</a>
<a class="right-next"
href="2_statements.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Statements and Packaging</p>
<p class="prev-next-title">3. Statements and Packaging</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
26 changes: 14 additions & 12 deletions WS1/0_python_basics/2_statements.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Statements and Packaging &#8212; Dig4Bio-workshops</title>
<title>3. Statements and Packaging &#8212; Dig4Bio-workshops</title>



Expand Down Expand Up @@ -62,8 +62,8 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'WS1/0_python_basics/2_statements';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Conditionality and Repetition" href="3_control_flow.html" />
<link rel="prev" title="Hello, World!" href="1_hello_world.html" />
<link rel="next" title="4. Conditionality and Repetition" href="3_control_flow.html" />
<link rel="prev" title="2. Hello, World!" href="1_hello_world.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -184,10 +184,12 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Introduction to Python (WS1)</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../intro_to_ws1.html">Introduction to workshop 1</a></li>
<li class="toctree-l1"><a class="reference internal" href="0_python_basics.html">Python Basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="1_hello_world.html">Hello World</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="3_control_flow.html">Control flow</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="0_python_basics.html">Module 1</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="1_hello_world.html">Hello World</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="3_control_flow.html">Control flow</a></li>
</ul>
</details></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Model-based Techniques (WS2)</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -412,7 +414,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Statements and Packaging</h1>
<h1>3. Statements and Packaging</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand Down Expand Up @@ -450,7 +452,7 @@ <h2> Contents </h2>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="statements-and-packaging">
<h1>Statements and Packaging<a class="headerlink" href="#statements-and-packaging" title="Link to this heading">#</a></h1>
<h1>3. Statements and Packaging<a class="headerlink" href="#statements-and-packaging" title="Link to this heading">#</a></h1>
<p>A <strong>statement</strong> is an instruction that your program can execute.
In Python, you can compute, bind, or save values in different ways.</p>
<p>Some of the most common ways are:</p>
Expand Down Expand Up @@ -743,7 +745,7 @@ <h2>3. Lists and generators<a class="headerlink" href="#lists-and-generators" ti
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;generator object &lt;genexpr&gt; at 0x0000023C236834C0&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;generator object &lt;genexpr&gt; at 0x000002615AC734C0&gt;
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -1105,15 +1107,15 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Hello, World!</p>
<p class="prev-next-title">2. Hello, World!</p>
</div>
</a>
<a class="right-next"
href="3_control_flow.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Conditionality and Repetition</p>
<p class="prev-next-title">4. Conditionality and Repetition</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
42 changes: 36 additions & 6 deletions WS1/intro_to_ws1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'WS1/intro_to_ws1';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Introduction to Python" href="0_python_basics/0_python_basics.html" />
<link rel="next" title="1. Introduction to Python" href="0_python_basics/0_python_basics.html" />
<link rel="prev" title="Dig4Bio workshops" href="../index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -182,10 +182,12 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Introduction to Python (WS1)</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Introduction to workshop 1</a></li>
<li class="toctree-l1"><a class="reference internal" href="0_python_basics/0_python_basics.html">Python Basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="0_python_basics/1_hello_world.html">Hello World</a></li>
<li class="toctree-l1"><a class="reference internal" href="0_python_basics/2_statements.html">Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="0_python_basics/3_control_flow.html">Control flow</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="0_python_basics/0_python_basics.html">Module 1</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="0_python_basics/1_hello_world.html">Hello World</a></li>
<li class="toctree-l2"><a class="reference internal" href="0_python_basics/2_statements.html">Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="0_python_basics/3_control_flow.html">Control flow</a></li>
</ul>
</details></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Model-based Techniques (WS2)</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -416,6 +418,34 @@ <h2>Objective<a class="headerlink" href="#objective" title="Link to this heading
</section>
<section id="course-plan">
<h2>course plan<a class="headerlink" href="#course-plan" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="table">
<thead>
<tr class="row-odd"><th class="head"><p>Modele no.</p></th>
<th class="head"><p>Content</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Module 1</p></td>
<td><p>syntax, statements, and control flow</p></td>
</tr>
<tr class="row-odd"><td><p>Module 2</p></td>
<td><p>data structures and data visualization</p></td>
</tr>
<tr class="row-even"><td><p>Module 3</p></td>
<td><p>operations, solving ODEs, stoichiometry</p></td>
</tr>
<tr class="row-odd"><td><p>Module 4</p></td>
<td><p>design of reactors, combine mass and energy balances</p></td>
</tr>
<tr class="row-even"><td><p>Module 5</p></td>
<td><p>Fed-batch model for E.coli (model A)</p></td>
</tr>
<tr class="row-odd"><td><p>Module 6&amp;7</p></td>
<td><p>diafiltration and cell lysis (downstream)</p></td>
</tr>
</tbody>
</table>
</div>
</section>
</section>

Expand Down Expand Up @@ -463,7 +493,7 @@ <h2>course plan<a class="headerlink" href="#course-plan" title="Link to this hea
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Introduction to Python</p>
<p class="prev-next-title">1. Introduction to Python</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
12 changes: 11 additions & 1 deletion _sources/WS1/0_python_basics/0_python_basics.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Introduction to Python"
"# 1. Introduction to Python"
]
},
{
Expand Down Expand Up @@ -103,6 +103,16 @@
"this course has been taken and adapted from The course [*Chemical Reaction engineering in Python*](https://github.com/FiammettaC/Chemical-Reaction-Engineering-in-Python) by Fiammetta Caccavale.\n",
":::"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
Expand Down
4 changes: 2 additions & 2 deletions _sources/WS1/0_python_basics/1_hello_world.ipynb
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _sources/WS1/0_python_basics/2_statements.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": "b8630b2e-e580-4247-a4c3-ea2fc7910a78",
"metadata": {},
"source": [
"# Statements and Packaging"
"# 3. Statements and Packaging"
]
},
{
Expand Down
8 changes: 8 additions & 0 deletions _sources/WS1/intro_to_ws1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,13 @@ with examples of upstreams and downstream process modelling. This course was pro

## course plan

| Modele no. | Content |
|--------------|--------------------------------------------------------|
| Module 1 | syntax, statements, and control flow |
| Module 2 | data structures and data visualization |
| Module 3 | operations, solving ODEs, stoichiometry |
| Module 4 | design of reactors, combine mass and energy balances |
| Module 5 | Fed-batch model for E.coli (model A) |
| Module 6&7 | diafiltration and cell lysis (downstream) |


12 changes: 6 additions & 6 deletions _sources/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ The Dig4Bio consotrium includes
height="300"
style="display: block; margin: 0 auto" />


## Dates
The workshops are held in a hybrid format. These are the dates:

| Event | Date |
|-------|------|
| | |
| | |
| | |
| Event | Date |
|----------------------------|-------------------|
| Introduction to Python | 10-12/09/2024 |
| Model-based Techniques | 29-31/10/2024 |
| TBA | |

# Content

Expand Down
Loading

0 comments on commit 7353072

Please sign in to comment.