Skip to content

Commit

Permalink
deploy: b8b4a0d
Browse files Browse the repository at this point in the history
  • Loading branch information
@ma-sadeghi
ma-sadeghi committed Oct 13, 2023
1 parent a48846a commit 2fae1e8
Show file tree
Hide file tree
Showing 42 changed files with 129 additions and 112 deletions.
Binary file added _images/beatmap_logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 9 additions & 3 deletions _sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
.. module:: beatmap
:noindex:

################################
Welcome to BEaTmap documentation
################################
.. image:: ./_static/beatmap_logo.png
:name: logo

##########################
BEaTmap: BET Analysis Tool
##########################

What is BEaTmap?
################
Expand All @@ -15,6 +18,9 @@ adsorption isotherms is very widely done using the theory developed by
Brunauer, Emmett, and Teller in the 1950s. The BET (or BEaT) theory is so
commonly place that the acronym has is synonymous with surface area.

.. image:: ./_static/beatmap_logo.png
:name: banner

The BET theory was derived with several assumptions, and these must be met
for the predicted surface area to be valid. Rouquerol et al have put forth
criteria to evaluate whether isothermal adsoprtion data meets the
Expand Down
Binary file added _static/beatmap_logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions _static/custom.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,21 @@ div.highlight > pre {
margin-top: -5px;
margin-bottom: -5px;
}

img#banner {
float: right;
opacity: 1;
display: block;
margin-right: auto;
margin-left: 20px;
height: 200px;
}

img#logo {
float: left;
opacity: 1;
display: block;
margin-left: auto;
margin-right: 20px;
height: 110px;
}
2 changes: 1 addition & 1 deletion genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=42246f4c" />



Expand Down
114 changes: 53 additions & 61 deletions getting_started.html
View file

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=42246f4c" />



Expand Down Expand Up @@ -232,14 +232,16 @@
</label>
</div>
<article role="main">
<section id="welcome-to-beatmap-documentation">
<span id="front-page"></span><h1>Welcome to BEaTmap documentation<a class="headerlink" href="#welcome-to-beatmap-documentation" title="Link to this heading">#</a></h1>
<span id="front-page"></span><img alt="_images/beatmap_logo.png" id="logo" src="_images/beatmap_logo.png" />
<section id="beatmap-bet-analysis-tool">
<h1>BEaTmap: BET Analysis Tool<a class="headerlink" href="#beatmap-bet-analysis-tool" title="Link to this heading">#</a></h1>
<section id="what-is-beatmap">
<h2>What is BEaTmap?<a class="headerlink" href="#what-is-beatmap" title="Link to this heading">#</a></h2>
<p>Obtaining surface area of a porous sample from the interpretation of gas
adsorption isotherms is very widely done using the theory developed by
Brunauer, Emmett, and Teller in the 1950s. The BET (or BEaT) theory is so
commonly place that the acronym has is synonymous with surface area.</p>
<img alt="_images/beatmap_logo.png" id="banner" src="_images/beatmap_logo.png" />
<p>The BET theory was derived with several assumptions, and these must be met
for the predicted surface area to be valid. Rouquerol et al have put forth
criteria to evaluate whether isothermal adsoprtion data meets the
Expand Down Expand Up @@ -308,7 +310,7 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Welcome to BEaTmap documentation</a><ul>
<li><a class="reference internal" href="#">BEaTmap: BET Analysis Tool</a><ul>
<li><a class="reference internal" href="#what-is-beatmap">What is BEaTmap?</a></li>
<li><a class="reference internal" href="#contents">Contents</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.bet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.check_absorbed_amount.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.check_enough_datapoints.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.check_pressure_consistency.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.check_pressure_increasing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.check_y_intercept_positive.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
2 changes: 1 addition & 1 deletion modules/generated/beatmap.core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down
6 changes: 3 additions & 3 deletions modules/generated/beatmap.core.rouq_mask.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=4b35d38f" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=42246f4c" />



Expand Down Expand Up @@ -236,7 +236,7 @@
<h1>rouq_mask<a class="headerlink" href="#rouq-mask" title="Link to this heading">#</a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="beatmap.core.rouq_mask">
<span class="sig-prename descclassname"><span class="pre">beatmap.core.</span></span><span class="sig-name descname"><span class="pre">rouq_mask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">intercept</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iso_df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slope</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_y_intercept_positive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_pressure_increasing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_absorbed_amount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_relative_pressure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_enough_datapoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">points</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#beatmap.core.rouq_mask" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">beatmap.core.</span></span><span class="sig-name descname"><span class="pre">rouq_mask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">intercept</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iso_df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slope</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_y_intercept_positive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_pressure_increasing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_absorbed_amount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_relative_pressure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_enough_datapoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_num_points</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#beatmap.core.rouq_mask" title="Link to this definition">#</a></dt>
<dd><p>Calls all check functions and combines their masks into one “rouqerol mask”.</p>
<p>Rather than pass individual parameters, this function can accept
<code class="docutils literal notranslate"><span class="pre">bet_results</span></code> (where <code class="docutils literal notranslate"><span class="pre">bet_results</span></code> is a named tuple output by the bet
Expand All @@ -262,7 +262,7 @@ <h1>rouq_mask<a class="headerlink" href="#rouq-mask" title="Link to this heading
</dd>
<dt><strong>enforce_enough_datapoints</strong><span class="classifier">bool</span></dt><dd><p>If True, this check will be evaluated, otherwise skipped.</p>
</dd>
<dt><strong>points</strong><span class="classifier">int</span></dt><dd><p>The minimum number of experimental data points for a relative pressure
<dt><strong>min_num_points</strong><span class="classifier">int</span></dt><dd><p>The minimum number of experimental data points for a relative pressure
interval to be considered valid.</p>
</dd>
</dl>
Expand Down
Loading

0 comments on commit 2fae1e8

Please sign in to comment.