Skip to content

Commit a805503

Browse files
github-merge-queue[bot]github-merge-queue[bot]
committed
Deploying to pdoc from @ 68e48e1 🚀
1 parent ab5a025 commit a805503

2 files changed

Lines changed: 320 additions & 2 deletions

File tree

‎PyPartMC.html‎

Lines changed: 319 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,24 @@ <h2>API Documentation</h2>
4141
<li>
4242
<a class="variable" href="#__version__">__version__</a>
4343
</li>
44+
<li>
45+
<a class="class" href="#AeroBinned">AeroBinned</a>
46+
<ul class="memberlist">
47+
<li>
48+
<a class="function" href="#AeroBinned.__init__">AeroBinned</a>
49+
</li>
50+
<li>
51+
<a class="variable" href="#AeroBinned.num_conc">num_conc</a>
52+
</li>
53+
<li>
54+
<a class="variable" href="#AeroBinned.vol_conc">vol_conc</a>
55+
</li>
56+
<li>
57+
<a class="function" href="#AeroBinned.add_aero_dist">add_aero_dist</a>
58+
</li>
59+
</ul>
60+
61+
</li>
4462
<li>
4563
<a class="class" href="#AeroData">AeroData</a>
4664
<ul class="memberlist">
@@ -347,6 +365,9 @@ <h2>API Documentation</h2>
347365
<li>
348366
<a class="variable" href="#BinGrid.centers">centers</a>
349367
</li>
368+
<li>
369+
<a class="variable" href="#BinGrid.widths">widths</a>
370+
</li>
350371
</ul>
351372

352373
</li>
@@ -457,6 +478,33 @@ <h2>API Documentation</h2>
457478
</li>
458479
</ul>
459480

481+
</li>
482+
<li>
483+
<a class="class" href="#RunSectOpt">RunSectOpt</a>
484+
<ul class="memberlist">
485+
<li>
486+
<a class="function" href="#RunSectOpt.__init__">RunSectOpt</a>
487+
</li>
488+
<li>
489+
<a class="variable" href="#RunSectOpt.t_max">t_max</a>
490+
</li>
491+
<li>
492+
<a class="variable" href="#RunSectOpt.del_t">del_t</a>
493+
</li>
494+
</ul>
495+
496+
</li>
497+
<li>
498+
<a class="class" href="#RunExactOpt">RunExactOpt</a>
499+
<ul class="memberlist">
500+
<li>
501+
<a class="function" href="#RunExactOpt.__init__">RunExactOpt</a>
502+
</li>
503+
<li>
504+
<a class="variable" href="#RunExactOpt.t_max">t_max</a>
505+
</li>
506+
</ul>
507+
460508
</li>
461509
<li>
462510
<a class="class" href="#Scenario">Scenario</a>
@@ -506,6 +554,12 @@ <h2>API Documentation</h2>
506554
<li>
507555
<a class="function" href="#run_part_timestep">run_part_timestep</a>
508556
</li>
557+
<li>
558+
<a class="function" href="#run_sect">run_sect</a>
559+
</li>
560+
<li>
561+
<a class="function" href="#run_exact">run_exact</a>
562+
</li>
509563
<li>
510564
<a class="function" href="#pow2_above">pow2_above</a>
511565
</li>
@@ -542,6 +596,12 @@ <h2>API Documentation</h2>
542596
<li>
543597
<a class="function" href="#input_state">input_state</a>
544598
</li>
599+
<li>
600+
<a class="function" href="#input_sectional">input_sectional</a>
601+
</li>
602+
<li>
603+
<a class="function" href="#input_exact">input_exact</a>
604+
</li>
545605
<li>
546606
<a class="function" href="#rand_init">rand_init</a>
547607
</li>
@@ -1066,6 +1126,86 @@ <h4 id="partmc">PartMC:</h4>
10661126

10671127

10681128

1129+
</section>
1130+
<section id="AeroBinned">
1131+
<div class="attr class">
1132+
1133+
<span class="def">class</span>
1134+
<span class="name">AeroBinned</span><wbr>(<span class="base">pybind11_builtins.pybind11_object</span>):
1135+
1136+
1137+
</div>
1138+
<a class="headerlink" href="#AeroBinned"></a>
1139+
1140+
<div class="docstring"><p>Aerosol number and volume distributions stored per size bin.
1141+
These quantities are densities both in volume (per m^3) and in radius
1142+
(per log_width).</p>
1143+
</div>
1144+
1145+
1146+
<div id="AeroBinned.__init__" class="classattr">
1147+
<div class="attr function">
1148+
1149+
<span class="name">AeroBinned</span><span class="signature pdoc-code condensed">()</span>
1150+
1151+
1152+
</div>
1153+
<a class="headerlink" href="#AeroBinned.__init__"></a>
1154+
1155+
<div class="docstring"><p>__init__(<em>args, *</em>kwargs)
1156+
Overloaded function.</p>
1157+
1158+
<ol>
1159+
<li><p>__init__(self: _PyPartMC.AeroBinned, arg0: AeroData) -> None</p></li>
1160+
<li><p>__init__(self: _PyPartMC.AeroBinned, arg0: AeroData, arg1: BinGrid) -> None</p></li>
1161+
</ol>
1162+
</div>
1163+
1164+
1165+
</div>
1166+
<div id="AeroBinned.num_conc" class="classattr">
1167+
<div class="attr variable">
1168+
<span class="name">num_conc</span>
1169+
1170+
1171+
</div>
1172+
<a class="headerlink" href="#AeroBinned.num_conc"></a>
1173+
1174+
<div class="docstring"><p>(arg0: _PyPartMC.AeroBinned) -> List[float]</p>
1175+
</div>
1176+
1177+
1178+
</div>
1179+
<div id="AeroBinned.vol_conc" class="classattr">
1180+
<div class="attr variable">
1181+
<span class="name">vol_conc</span>
1182+
1183+
1184+
</div>
1185+
<a class="headerlink" href="#AeroBinned.vol_conc"></a>
1186+
1187+
<div class="docstring"><p>(arg0: _PyPartMC.AeroBinned) -> List[List[float]]</p>
1188+
</div>
1189+
1190+
1191+
</div>
1192+
<div id="AeroBinned.add_aero_dist" class="classattr">
1193+
<div class="attr function">
1194+
1195+
<span class="def">def</span>
1196+
<span class="name">add_aero_dist</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>
1197+
1198+
1199+
</div>
1200+
<a class="headerlink" href="#AeroBinned.add_aero_dist"></a>
1201+
1202+
<div class="docstring"><p>add_aero_dist(self: _PyPartMC.AeroBinned, arg0: BinGrid, arg1: AeroDist) -> None</p>
1203+
1204+
<p>Adds an AeroDist to an AeroBinned</p>
1205+
</div>
1206+
1207+
1208+
</div>
10691209
</section>
10701210
<section id="AeroData">
10711211
<div class="attr class">
@@ -2548,6 +2688,19 @@ <h4 id="partmc">PartMC:</h4>
25482688
</div>
25492689

25502690

2691+
</div>
2692+
<div id="BinGrid.widths" class="classattr">
2693+
<div class="attr variable">
2694+
<span class="name">widths</span>
2695+
2696+
2697+
</div>
2698+
<a class="headerlink" href="#BinGrid.widths"></a>
2699+
2700+
<div class="docstring"><p>(arg0: _PyPartMC.BinGrid) -> List[float]</p>
2701+
</div>
2702+
2703+
25512704
</div>
25522705
</section>
25532706
<section id="CampCore">
@@ -2993,6 +3146,103 @@ <h4 id="partmc">PartMC:</h4>
29933146
</div>
29943147

29953148

3149+
</div>
3150+
</section>
3151+
<section id="RunSectOpt">
3152+
<div class="attr class">
3153+
3154+
<span class="def">class</span>
3155+
<span class="name">RunSectOpt</span><wbr>(<span class="base">pybind11_builtins.pybind11_object</span>):
3156+
3157+
3158+
</div>
3159+
<a class="headerlink" href="#RunSectOpt"></a>
3160+
3161+
<div class="docstring"><p>Options controlling the execution of run_sect().</p>
3162+
</div>
3163+
3164+
3165+
<div id="RunSectOpt.__init__" class="classattr">
3166+
<div class="attr function">
3167+
3168+
<span class="name">RunSectOpt</span><span class="signature pdoc-code condensed">()</span>
3169+
3170+
3171+
</div>
3172+
<a class="headerlink" href="#RunSectOpt.__init__"></a>
3173+
3174+
<div class="docstring"><p>__init__(self: _PyPartMC.RunSectOpt, arg0: json, arg1: _PyPartMC.EnvState) -> None</p>
3175+
</div>
3176+
3177+
3178+
</div>
3179+
<div id="RunSectOpt.t_max" class="classattr">
3180+
<div class="attr variable">
3181+
<span class="name">t_max</span>
3182+
3183+
3184+
</div>
3185+
<a class="headerlink" href="#RunSectOpt.t_max"></a>
3186+
3187+
<div class="docstring"><p>(arg0: _PyPartMC.RunSectOpt) -> float</p>
3188+
</div>
3189+
3190+
3191+
</div>
3192+
<div id="RunSectOpt.del_t" class="classattr">
3193+
<div class="attr variable">
3194+
<span class="name">del_t</span>
3195+
3196+
3197+
</div>
3198+
<a class="headerlink" href="#RunSectOpt.del_t"></a>
3199+
3200+
<div class="docstring"><p>(arg0: _PyPartMC.RunSectOpt) -> float</p>
3201+
</div>
3202+
3203+
3204+
</div>
3205+
</section>
3206+
<section id="RunExactOpt">
3207+
<div class="attr class">
3208+
3209+
<span class="def">class</span>
3210+
<span class="name">RunExactOpt</span><wbr>(<span class="base">pybind11_builtins.pybind11_object</span>):
3211+
3212+
3213+
</div>
3214+
<a class="headerlink" href="#RunExactOpt"></a>
3215+
3216+
<div class="docstring"><p>Options controlling the execution of run_exact().</p>
3217+
</div>
3218+
3219+
3220+
<div id="RunExactOpt.__init__" class="classattr">
3221+
<div class="attr function">
3222+
3223+
<span class="name">RunExactOpt</span><span class="signature pdoc-code condensed">()</span>
3224+
3225+
3226+
</div>
3227+
<a class="headerlink" href="#RunExactOpt.__init__"></a>
3228+
3229+
<div class="docstring"><p>__init__(self: _PyPartMC.RunExactOpt, arg0: json, arg1: _PyPartMC.EnvState) -> None</p>
3230+
</div>
3231+
3232+
3233+
</div>
3234+
<div id="RunExactOpt.t_max" class="classattr">
3235+
<div class="attr variable">
3236+
<span class="name">t_max</span>
3237+
3238+
3239+
</div>
3240+
<a class="headerlink" href="#RunExactOpt.t_max"></a>
3241+
3242+
<div class="docstring"><p>(arg0: _PyPartMC.RunExactOpt) -> float</p>
3243+
</div>
3244+
3245+
29963246
</div>
29973247
</section>
29983248
<section id="Scenario">
@@ -3232,6 +3482,40 @@ <h4 id="partmc">PartMC:</h4>
32323482
</div>
32333483

32343484

3485+
</section>
3486+
<section id="run_sect">
3487+
<div class="attr function">
3488+
3489+
<span class="def">def</span>
3490+
<span class="name">run_sect</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>
3491+
3492+
3493+
</div>
3494+
<a class="headerlink" href="#run_sect"></a>
3495+
3496+
<div class="docstring"><p>run_sect(arg0: BinGrid, arg1: GasData, arg2: AeroData, arg3: AeroDist, arg4: Scenario, arg5: EnvState, arg6: RunSectOpt) -> None</p>
3497+
3498+
<p>Do a 1D sectional simulation (Bott 1998 scheme).</p>
3499+
</div>
3500+
3501+
3502+
</section>
3503+
<section id="run_exact">
3504+
<div class="attr function">
3505+
3506+
<span class="def">def</span>
3507+
<span class="name">run_exact</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>
3508+
3509+
3510+
</div>
3511+
<a class="headerlink" href="#run_exact"></a>
3512+
3513+
<div class="docstring"><p>run_exact(arg0: BinGrid, arg1: GasData, arg2: AeroData, arg3: AeroDist, arg4: Scenario, arg5: EnvState, arg6: RunExactOpt) -> None</p>
3514+
3515+
<p>Do an exact solution simulation.</p>
3516+
</div>
3517+
3518+
32353519
</section>
32363520
<section id="pow2_above">
32373521
<div class="attr function">
@@ -3432,7 +3716,41 @@ <h4 id="partmc">PartMC:</h4>
34323716

34333717
<div class="docstring"><p>input_state(arg0: str) -> Tuple[_PyPartMC.AeroData, _PyPartMC.AeroState, _PyPartMC.GasData, _PyPartMC.GasState, _PyPartMC.EnvState]</p>
34343718

3435-
<p>Read current state from netCDF output file.</p>
3719+
<p>Read current state from run_part netCDF output file.</p>
3720+
</div>
3721+
3722+
3723+
</section>
3724+
<section id="input_sectional">
3725+
<div class="attr function">
3726+
3727+
<span class="def">def</span>
3728+
<span class="name">input_sectional</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>
3729+
3730+
3731+
</div>
3732+
<a class="headerlink" href="#input_sectional"></a>
3733+
3734+
<div class="docstring"><p>input_sectional(arg0: str) -> Tuple[_PyPartMC.AeroData, _PyPartMC.BinGrid, _PyPartMC.AeroBinned, _PyPartMC.GasData, _PyPartMC.GasState, _PyPartMC.EnvState]</p>
3735+
3736+
<p>Read current state from run_sect netCDF output file.</p>
3737+
</div>
3738+
3739+
3740+
</section>
3741+
<section id="input_exact">
3742+
<div class="attr function">
3743+
3744+
<span class="def">def</span>
3745+
<span class="name">input_exact</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>
3746+
3747+
3748+
</div>
3749+
<a class="headerlink" href="#input_exact"></a>
3750+
3751+
<div class="docstring"><p>input_exact(arg0: str) -> Tuple[_PyPartMC.AeroData, _PyPartMC.BinGrid, _PyPartMC.AeroBinned, _PyPartMC.GasData, _PyPartMC.GasState, _PyPartMC.EnvState]</p>
3752+
3753+
<p>Read current state from run_exact netCDF output file.</p>
34363754
</div>
34373755

34383756

0 commit comments

Comments
 (0)