deploy: a7046cf

getting_started.html

@@ -284,7 +284,31 @@ <h3>Automated BET analysis<a class="headerlink" href="#automated-bet-analysis" t
 <span class="kn">import</span> <span class="nn">matplotlib.pylot</span> <span class="k">as</span> <span class="nn">plt</span>
 
 <span class="n">fpath</span> <span class="o">=</span> <span class="n">bt</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">get_fixtures_path</span><span class="p">()</span> <span class="o">/</span> <span class="s1">&#39;vulcan_chex.csv&#39;</span>
-<span class="n">bt</span><span class="o">.</span><span class="n">run_beatmap</span><span class="p">(</span><span class="n">file</span><span class="o">=</span><span class="n">fpath</span><span class="p">,</span> <span class="n">info</span><span class="o">=</span><span class="s1">&#39;chex on vulcan&#39;</span><span class="p">,</span> <span class="n">a_o</span><span class="o">=</span><span class="mi">39</span><span class="p">)</span>
+
+<span class="n">rouq_criteria</span> <span class="o">=</span> <span class="p">{</span>
+    <span class="s2">&quot;enforce_y_intercept_positive&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="s2">&quot;enforce_pressure_increasing&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="s2">&quot;enforce_absorbed_amount&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="s2">&quot;enforce_relative_pressure&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="s2">&quot;enforce_enough_datapoints&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="s2">&quot;min_num_points&quot;</span><span class="p">:</span> <span class="mi">5</span>
+<span class="p">}</span>
+
+<span class="n">aux_params</span> <span class="o">=</span> <span class="p">{</span>
+    <span class="s2">&quot;save_figures&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
+    <span class="s2">&quot;export_data&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+    <span class="s2">&quot;ssa_gradient&quot;</span><span class="p">:</span> <span class="s2">&quot;Greens&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;err_gradient&quot;</span><span class="p">:</span> <span class="s2">&quot;Greys&quot;</span>
+<span class="p">}</span>
+
+<span class="n">results</span> <span class="o">=</span> <span class="n">bt</span><span class="o">.</span><span class="n">run_beatmap</span><span class="p">(</span>
+    <span class="n">file</span><span class="o">=</span><span class="n">fpath</span><span class="p">,</span>
+    <span class="n">info</span><span class="o">=</span><span class="s2">&quot;chex on vulcan&quot;</span>
+    <span class="n">a_o</span><span class="o">=</span><span class="mi">39</span><span class="p">,</span>
+    <span class="n">ssa_criterion</span><span class="o">=</span><span class="s2">&quot;error&quot;</span><span class="p">,</span>
+    <span class="o">**</span><span class="n">rouq_criteria</span><span class="p">,</span>
+    <span class="o">**</span><span class="n">aux_params</span>
+<span class="p">)</span>
 </pre></div>
 </div>
 </section>

modules/generated/beatmap.core.run_beatmap.html

@@ -237,7 +237,7 @@
 <h1>run_beatmap<a class="headerlink" href="#run-beatmap" title="Link to this heading">#</a></h1>
 <dl class="py function">
 <dt class="sig sig-object py" id="beatmap.core.run_beatmap">
-<span class="sig-prename descclassname"><span class="pre">beatmap.core.</span></span><span class="sig-name descname"><span class="pre">run_beatmap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">a_o</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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>, <em class="sig-param"><span class="n"><span class="pre">save_figures</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">export_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssa_criterion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'error'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssa_gradient</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'greens'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err_gradient</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'greys'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#beatmap.core.run_beatmap" 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">run_beatmap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">a_o</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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>, <em class="sig-param"><span class="n"><span class="pre">save_figures</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">export_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssa_criterion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'error'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssa_gradient</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Greens'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err_gradient</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Greys'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#beatmap.core.run_beatmap" title="Link to this definition">#</a></dt>
 <dd><p>A single function that executes all necessary BEaTmap algorithims.</p>
 <p>This function is built to be as user friendly as possible. The file
 name/path of the isotherm data, information about the isotherm, and the