-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathPyPartMC.html
3493 lines (2434 loc) · 206 KB
/
PyPartMC.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc 15.0.1"/>
<title>PyPartMC API documentation</title>
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
<style>/*! syntax-highlighting.css */pre{line-height:125%;}span.linenos{color:inherit; background-color:transparent; padding-left:5px; padding-right:20px;}.pdoc-code .hll{background-color:#ffffcc}.pdoc-code{background:#f8f8f8;}.pdoc-code .c{color:#3D7B7B; font-style:italic}.pdoc-code .err{border:1px solid #FF0000}.pdoc-code .k{color:#008000; font-weight:bold}.pdoc-code .o{color:#666666}.pdoc-code .ch{color:#3D7B7B; font-style:italic}.pdoc-code .cm{color:#3D7B7B; font-style:italic}.pdoc-code .cp{color:#9C6500}.pdoc-code .cpf{color:#3D7B7B; font-style:italic}.pdoc-code .c1{color:#3D7B7B; font-style:italic}.pdoc-code .cs{color:#3D7B7B; font-style:italic}.pdoc-code .gd{color:#A00000}.pdoc-code .ge{font-style:italic}.pdoc-code .gr{color:#E40000}.pdoc-code .gh{color:#000080; font-weight:bold}.pdoc-code .gi{color:#008400}.pdoc-code .go{color:#717171}.pdoc-code .gp{color:#000080; font-weight:bold}.pdoc-code .gs{font-weight:bold}.pdoc-code .gu{color:#800080; font-weight:bold}.pdoc-code .gt{color:#0044DD}.pdoc-code .kc{color:#008000; font-weight:bold}.pdoc-code .kd{color:#008000; font-weight:bold}.pdoc-code .kn{color:#008000; font-weight:bold}.pdoc-code .kp{color:#008000}.pdoc-code .kr{color:#008000; font-weight:bold}.pdoc-code .kt{color:#B00040}.pdoc-code .m{color:#666666}.pdoc-code .s{color:#BA2121}.pdoc-code .na{color:#687822}.pdoc-code .nb{color:#008000}.pdoc-code .nc{color:#0000FF; font-weight:bold}.pdoc-code .no{color:#880000}.pdoc-code .nd{color:#AA22FF}.pdoc-code .ni{color:#717171; font-weight:bold}.pdoc-code .ne{color:#CB3F38; font-weight:bold}.pdoc-code .nf{color:#0000FF}.pdoc-code .nl{color:#767600}.pdoc-code .nn{color:#0000FF; font-weight:bold}.pdoc-code .nt{color:#008000; font-weight:bold}.pdoc-code .nv{color:#19177C}.pdoc-code .ow{color:#AA22FF; font-weight:bold}.pdoc-code .w{color:#bbbbbb}.pdoc-code .mb{color:#666666}.pdoc-code .mf{color:#666666}.pdoc-code .mh{color:#666666}.pdoc-code .mi{color:#666666}.pdoc-code .mo{color:#666666}.pdoc-code .sa{color:#BA2121}.pdoc-code .sb{color:#BA2121}.pdoc-code .sc{color:#BA2121}.pdoc-code .dl{color:#BA2121}.pdoc-code .sd{color:#BA2121; font-style:italic}.pdoc-code .s2{color:#BA2121}.pdoc-code .se{color:#AA5D1F; font-weight:bold}.pdoc-code .sh{color:#BA2121}.pdoc-code .si{color:#A45A77; font-weight:bold}.pdoc-code .sx{color:#008000}.pdoc-code .sr{color:#A45A77}.pdoc-code .s1{color:#BA2121}.pdoc-code .ss{color:#19177C}.pdoc-code .bp{color:#008000}.pdoc-code .fm{color:#0000FF}.pdoc-code .vc{color:#19177C}.pdoc-code .vg{color:#19177C}.pdoc-code .vi{color:#19177C}.pdoc-code .vm{color:#19177C}.pdoc-code .il{color:#666666}</style>
<style>/*! theme.css */:root{--pdoc-background:#fff;}.pdoc{--text:#212529;--muted:#6c757d;--link:#3660a5;--link-hover:#1659c5;--code:#f8f8f8;--active:#fff598;--accent:#eee;--accent2:#c1c1c1;--nav-hover:rgba(255, 255, 255, 0.5);--name:#0066BB;--def:#008800;--annotation:#007020;}</style>
<style>/*! layout.css */html, body{width:100%;height:100%;}html, main{scroll-behavior:smooth;}body{background-color:var(--pdoc-background);}@media (max-width:769px){#navtoggle{cursor:pointer;position:absolute;width:50px;height:40px;top:1rem;right:1rem;border-color:var(--text);color:var(--text);display:flex;opacity:0.8;z-index:999;}#navtoggle:hover{opacity:1;}#togglestate + div{display:none;}#togglestate:checked + div{display:inherit;}main, header{padding:2rem 3vw;}header + main{margin-top:-3rem;}.git-button{display:none !important;}nav input[type="search"]{max-width:77%;}nav input[type="search"]:first-child{margin-top:-6px;}nav input[type="search"]:valid ~ *{display:none !important;}}@media (min-width:770px){:root{--sidebar-width:clamp(12.5rem, 28vw, 22rem);}nav{position:fixed;overflow:auto;height:100vh;width:var(--sidebar-width);}main, header{padding:3rem 2rem 3rem calc(var(--sidebar-width) + 3rem);width:calc(54rem + var(--sidebar-width));max-width:100%;}header + main{margin-top:-4rem;}#navtoggle{display:none;}}#togglestate{position:absolute;height:0;opacity:0;}nav.pdoc{--pad:clamp(0.5rem, 2vw, 1.75rem);--indent:1.5rem;background-color:var(--accent);border-right:1px solid var(--accent2);box-shadow:0 0 20px rgba(50, 50, 50, .2) inset;padding:0 0 0 var(--pad);overflow-wrap:anywhere;scrollbar-width:thin; scrollbar-color:var(--accent2) transparent; z-index:1}nav.pdoc::-webkit-scrollbar{width:.4rem; }nav.pdoc::-webkit-scrollbar-thumb{background-color:var(--accent2); }nav.pdoc > div{padding:var(--pad) 0;}nav.pdoc .module-list-button{display:inline-flex;align-items:center;color:var(--text);border-color:var(--muted);margin-bottom:1rem;}nav.pdoc .module-list-button:hover{border-color:var(--text);}nav.pdoc input[type=search]{display:block;outline-offset:0;width:calc(100% - var(--pad));}nav.pdoc .logo{max-width:calc(100% - var(--pad));max-height:35vh;display:block;margin:0 auto 1rem;transform:translate(calc(-.5 * var(--pad)), 0);}nav.pdoc ul{list-style:none;padding-left:0;}nav.pdoc > div > ul{margin-left:calc(0px - var(--pad));}nav.pdoc li a{padding:.2rem 0 .2rem calc(var(--pad) + var(--indent));}nav.pdoc > div > ul > li > a{padding-left:var(--pad);}nav.pdoc li{transition:all 100ms;}nav.pdoc li:hover{background-color:var(--nav-hover);}nav.pdoc a, nav.pdoc a:hover{color:var(--text);}nav.pdoc a{display:block;}nav.pdoc > h2:first-of-type{margin-top:1.5rem;}nav.pdoc .class:before{content:"class ";color:var(--muted);}nav.pdoc .function:after{content:"()";color:var(--muted);}nav.pdoc footer:before{content:"";display:block;width:calc(100% - var(--pad));border-top:solid var(--accent2) 1px;margin-top:1.5rem;padding-top:.5rem;}nav.pdoc footer{font-size:small;}</style>
<style>/*! content.css */.pdoc{color:var(--text);box-sizing:border-box;line-height:1.5;background:none;}.pdoc .pdoc-button{cursor:pointer;display:inline-block;border:solid black 1px;border-radius:2px;font-size:.75rem;padding:calc(0.5em - 1px) 1em;transition:100ms all;}.pdoc .alert{padding:1rem 1rem 1rem calc(1.5rem + 24px);border:1px solid transparent;border-radius:.25rem;background-repeat:no-repeat;background-position:.75rem center;margin-bottom:1rem;}.pdoc .alert > em{display:none;}.pdoc .alert > *:last-child{margin-bottom:0;}.pdoc .alert.note {color:#084298;background-color:#cfe2ff;border-color:#b6d4fe;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23084298%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8%2016A8%208%200%201%200%208%200a8%208%200%200%200%200%2016zm.93-9.412-1%204.705c-.07.34.029.533.304.533.194%200%20.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703%200-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381%202.29-.287zM8%205.5a1%201%200%201%201%200-2%201%201%200%200%201%200%202z%22/%3E%3C/svg%3E");}.pdoc .alert.warning{color:#664d03;background-color:#fff3cd;border-color:#ffecb5;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23664d03%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8.982%201.566a1.13%201.13%200%200%200-1.96%200L.165%2013.233c-.457.778.091%201.767.98%201.767h13.713c.889%200%201.438-.99.98-1.767L8.982%201.566zM8%205c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%205.995A.905.905%200%200%201%208%205zm.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2z%22/%3E%3C/svg%3E");}.pdoc .alert.danger{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M5.52.359A.5.5%200%200%201%206%200h4a.5.5%200%200%201%20.474.658L8.694%206H12.5a.5.5%200%200%201%20.395.807l-7%209a.5.5%200%200%201-.873-.454L6.823%209.5H3.5a.5.5%200%200%201-.48-.641l2.5-8.5z%22/%3E%3C/svg%3E");}.pdoc .visually-hidden{position:absolute !important;width:1px !important;height:1px !important;padding:0 !important;margin:-1px !important;overflow:hidden !important;clip:rect(0, 0, 0, 0) !important;white-space:nowrap !important;border:0 !important;}.pdoc h1, .pdoc h2, .pdoc h3{font-weight:300;margin:.3em 0;padding:.2em 0;}.pdoc > section:not(.module-info) h1{font-size:1.5rem;font-weight:500;}.pdoc > section:not(.module-info) h2{font-size:1.4rem;font-weight:500;}.pdoc > section:not(.module-info) h3{font-size:1.3rem;font-weight:500;}.pdoc > section:not(.module-info) h4{font-size:1.2rem;}.pdoc > section:not(.module-info) h5{font-size:1.1rem;}.pdoc a{text-decoration:none;color:var(--link);}.pdoc a:hover{color:var(--link-hover);}.pdoc blockquote{margin-left:2rem;}.pdoc pre{border-top:1px solid var(--accent2);border-bottom:1px solid var(--accent2);margin-top:0;margin-bottom:1em;padding:.5rem 0 .5rem .5rem;overflow-x:auto;background-color:var(--code);}.pdoc code{color:var(--text);padding:.2em .4em;margin:0;font-size:85%;background-color:var(--accent);border-radius:6px;}.pdoc a > code{color:inherit;}.pdoc pre > code{display:inline-block;font-size:inherit;background:none;border:none;padding:0;}.pdoc > section:not(.module-info){margin-bottom:1.5rem;}.pdoc .modulename{margin-top:0;font-weight:bold;}.pdoc .modulename a{color:var(--link);transition:100ms all;}.pdoc .git-button{float:right;border:solid var(--link) 1px;}.pdoc .git-button:hover{background-color:var(--link);color:var(--pdoc-background);}.view-source-toggle-state,.view-source-toggle-state ~ .pdoc-code{display:none;}.view-source-toggle-state:checked ~ .pdoc-code{display:block;}.view-source-button{display:inline-block;float:right;font-size:.75rem;line-height:1.5rem;color:var(--muted);padding:0 .4rem 0 1.3rem;cursor:pointer;text-indent:-2px;}.view-source-button > span{visibility:hidden;}.module-info .view-source-button{float:none;display:flex;justify-content:flex-end;margin:-1.2rem .4rem -.2rem 0;}.view-source-button::before{position:absolute;content:"View Source";display:list-item;list-style-type:disclosure-closed;}.view-source-toggle-state:checked ~ .attr .view-source-button::before,.view-source-toggle-state:checked ~ .view-source-button::before{list-style-type:disclosure-open;}.pdoc .docstring{margin-bottom:1.5rem;}.pdoc section:not(.module-info) .docstring{margin-left:clamp(0rem, 5vw - 2rem, 1rem);}.pdoc .docstring .pdoc-code{margin-left:1em;margin-right:1em;}.pdoc h1:target,.pdoc h2:target,.pdoc h3:target,.pdoc h4:target,.pdoc h5:target,.pdoc h6:target,.pdoc .pdoc-code > pre > span:target{background-color:var(--active);box-shadow:-1rem 0 0 0 var(--active);}.pdoc .pdoc-code > pre > span:target{display:block;}.pdoc div:target > .attr,.pdoc section:target > .attr,.pdoc dd:target > a{background-color:var(--active);}.pdoc *{scroll-margin:2rem;}.pdoc .pdoc-code .linenos{user-select:none;}.pdoc .attr:hover{filter:contrast(0.95);}.pdoc section, .pdoc .classattr{position:relative;}.pdoc .headerlink{--width:clamp(1rem, 3vw, 2rem);position:absolute;top:0;left:calc(0rem - var(--width));transition:all 100ms ease-in-out;opacity:0;}.pdoc .headerlink::before{content:"#";display:block;text-align:center;width:var(--width);height:2.3rem;line-height:2.3rem;font-size:1.5rem;}.pdoc .attr:hover ~ .headerlink,.pdoc *:target > .headerlink,.pdoc .headerlink:hover{opacity:1;}.pdoc .attr{display:block;margin:.5rem 0 .5rem;padding:.4rem .4rem .4rem 1rem;background-color:var(--accent);overflow-x:auto;}.pdoc .classattr{margin-left:2rem;}.pdoc .decorator-deprecated{color:#842029;}.pdoc .decorator-deprecated ~ span{filter:grayscale(1) opacity(0.8);}.pdoc .name{color:var(--name);font-weight:bold;}.pdoc .def{color:var(--def);font-weight:bold;}.pdoc .signature{background-color:transparent;}.pdoc .param, .pdoc .return-annotation{white-space:pre;}.pdoc .signature.multiline .param{display:block;}.pdoc .signature.condensed .param{display:inline-block;}.pdoc .annotation{color:var(--annotation);}.pdoc .view-value-toggle-state,.pdoc .view-value-toggle-state ~ .default_value{display:none;}.pdoc .view-value-toggle-state:checked ~ .default_value{display:inherit;}.pdoc .view-value-button{font-size:.5rem;vertical-align:middle;border-style:dashed;margin-top:-0.1rem;}.pdoc .view-value-button:hover{background:white;}.pdoc .view-value-button::before{content:"show";text-align:center;width:2.2em;display:inline-block;}.pdoc .view-value-toggle-state:checked ~ .view-value-button::before{content:"hide";}.pdoc .inherited{margin-left:2rem;}.pdoc .inherited dt{font-weight:700;}.pdoc .inherited dt, .pdoc .inherited dd{display:inline;margin-left:0;margin-bottom:.5rem;}.pdoc .inherited dd:not(:last-child):after{content:", ";}.pdoc .inherited .class:before{content:"class ";}.pdoc .inherited .function a:after{content:"()";}.pdoc .search-result .docstring{overflow:auto;max-height:25vh;}.pdoc .search-result.focused > .attr{background-color:var(--active);}.pdoc .attribution{margin-top:2rem;display:block;opacity:0.5;transition:all 200ms;filter:grayscale(100%);}.pdoc .attribution:hover{opacity:1;filter:grayscale(0%);}.pdoc .attribution img{margin-left:5px;height:35px;vertical-align:middle;width:70px;transition:all 200ms;}.pdoc table{display:block;width:max-content;max-width:100%;overflow:auto;margin-bottom:1rem;}.pdoc table th{font-weight:600;}.pdoc table th, .pdoc table td{padding:6px 13px;border:1px solid var(--accent2);}</style>
<style>/*! custom.css */</style></head>
<body>
<nav class="pdoc">
<label id="navtoggle" for="togglestate" class="pdoc-button"><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke-linecap='round' stroke="currentColor" stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg></label>
<input id="togglestate" type="checkbox" aria-hidden="true" tabindex="-1">
<div>
<h2>Contents</h2>
<ul>
<li><a href="#pypartmc">PyPartMC</a>
<ul>
<li><a href="#installation">Installation</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#usage-examples">Usage examples</a></li>
<li><a href="#other-packages-with-relevant-feature-scope">Other packages with relevant feature scope</a></li>
<li><a href="#faq">FAQ</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#acknowledgement-and-citations">Acknowledgement and citations</a></li>
<li><a href="#credits">Credits</a></li>
</ul></li>
</ul>
<h2>API Documentation</h2>
<ul class="memberlist">
<li>
<a class="variable" href="#__version__">__version__</a>
</li>
<li>
<a class="class" href="#AeroData">AeroData</a>
<ul class="memberlist">
<li>
<a class="function" href="#AeroData.__init__">AeroData</a>
</li>
<li>
<a class="function" href="#AeroData.spec_by_name">spec_by_name</a>
</li>
<li>
<a class="variable" href="#AeroData.n_source">n_source</a>
</li>
<li>
<a class="variable" href="#AeroData.sources">sources</a>
</li>
<li>
<a class="variable" href="#AeroData.frac_dim">frac_dim</a>
</li>
<li>
<a class="variable" href="#AeroData.vol_fill_factor">vol_fill_factor</a>
</li>
<li>
<a class="variable" href="#AeroData.prime_radius">prime_radius</a>
</li>
<li>
<a class="variable" href="#AeroData.densities">densities</a>
</li>
<li>
<a class="variable" href="#AeroData.kappa">kappa</a>
</li>
<li>
<a class="variable" href="#AeroData.molecular_weights">molecular_weights</a>
</li>
<li>
<a class="function" href="#AeroData.density">density</a>
</li>
<li>
<a class="function" href="#AeroData.rad2vol">rad2vol</a>
</li>
<li>
<a class="function" href="#AeroData.vol2rad">vol2rad</a>
</li>
<li>
<a class="function" href="#AeroData.diam2vol">diam2vol</a>
</li>
<li>
<a class="function" href="#AeroData.vol2diam">vol2diam</a>
</li>
<li>
<a class="variable" href="#AeroData.species">species</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#AeroDist">AeroDist</a>
<ul class="memberlist">
<li>
<a class="function" href="#AeroDist.__init__">AeroDist</a>
</li>
<li>
<a class="variable" href="#AeroDist.n_mode">n_mode</a>
</li>
<li>
<a class="variable" href="#AeroDist.num_conc">num_conc</a>
</li>
<li>
<a class="function" href="#AeroDist.mode">mode</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#AeroMode">AeroMode</a>
<ul class="memberlist">
<li>
<a class="function" href="#AeroMode.__init__">AeroMode</a>
</li>
<li>
<a class="variable" href="#AeroMode.num_conc">num_conc</a>
</li>
<li>
<a class="function" href="#AeroMode.num_dist">num_dist</a>
</li>
<li>
<a class="variable" href="#AeroMode.vol_frac">vol_frac</a>
</li>
<li>
<a class="variable" href="#AeroMode.vol_frac_std">vol_frac_std</a>
</li>
<li>
<a class="variable" href="#AeroMode.char_radius">char_radius</a>
</li>
<li>
<a class="variable" href="#AeroMode.gsd">gsd</a>
</li>
<li>
<a class="function" href="#AeroMode.set_sample">set_sample</a>
</li>
<li>
<a class="variable" href="#AeroMode.sample_num_conc">sample_num_conc</a>
</li>
<li>
<a class="variable" href="#AeroMode.sample_radius">sample_radius</a>
</li>
<li>
<a class="variable" href="#AeroMode.type">type</a>
</li>
<li>
<a class="variable" href="#AeroMode.name">name</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#AeroState">AeroState</a>
<ul class="memberlist">
<li>
<a class="function" href="#AeroState.__init__">AeroState</a>
</li>
<li>
<a class="variable" href="#AeroState.total_num_conc">total_num_conc</a>
</li>
<li>
<a class="variable" href="#AeroState.total_mass_conc">total_mass_conc</a>
</li>
<li>
<a class="variable" href="#AeroState.num_concs">num_concs</a>
</li>
<li>
<a class="function" href="#AeroState.masses">masses</a>
</li>
<li>
<a class="function" href="#AeroState.volumes">volumes</a>
</li>
<li>
<a class="variable" href="#AeroState.dry_diameters">dry_diameters</a>
</li>
<li>
<a class="function" href="#AeroState.mobility_diameters">mobility_diameters</a>
</li>
<li>
<a class="function" href="#AeroState.diameters">diameters</a>
</li>
<li>
<a class="function" href="#AeroState.crit_rel_humids">crit_rel_humids</a>
</li>
<li>
<a class="function" href="#AeroState.make_dry">make_dry</a>
</li>
<li>
<a class="variable" href="#AeroState.ids">ids</a>
</li>
<li>
<a class="function" href="#AeroState.mixing_state">mixing_state</a>
</li>
<li>
<a class="function" href="#AeroState.bin_average_comp">bin_average_comp</a>
</li>
<li>
<a class="function" href="#AeroState.particle">particle</a>
</li>
<li>
<a class="function" href="#AeroState.rand_particle">rand_particle</a>
</li>
<li>
<a class="function" href="#AeroState.dist_sample">dist_sample</a>
</li>
<li>
<a class="function" href="#AeroState.add_particle">add_particle</a>
</li>
<li>
<a class="function" href="#AeroState.add">add</a>
</li>
<li>
<a class="function" href="#AeroState.add_particles">add_particles</a>
</li>
<li>
<a class="function" href="#AeroState.sample">sample</a>
</li>
<li>
<a class="function" href="#AeroState.sample_particles">sample_particles</a>
</li>
<li>
<a class="function" href="#AeroState.copy_weight">copy_weight</a>
</li>
<li>
<a class="function" href="#AeroState.remove_particle">remove_particle</a>
</li>
<li>
<a class="function" href="#AeroState.zero">zero</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#AeroParticle">AeroParticle</a>
<ul class="memberlist">
<li>
<a class="function" href="#AeroParticle.__init__">AeroParticle</a>
</li>
<li>
<a class="variable" href="#AeroParticle.volumes">volumes</a>
</li>
<li>
<a class="variable" href="#AeroParticle.volume">volume</a>
</li>
<li>
<a class="function" href="#AeroParticle.species_volume">species_volume</a>
</li>
<li>
<a class="variable" href="#AeroParticle.dry_volume">dry_volume</a>
</li>
<li>
<a class="variable" href="#AeroParticle.radius">radius</a>
</li>
<li>
<a class="variable" href="#AeroParticle.dry_radius">dry_radius</a>
</li>
<li>
<a class="variable" href="#AeroParticle.diameter">diameter</a>
</li>
<li>
<a class="variable" href="#AeroParticle.dry_diameter">dry_diameter</a>
</li>
<li>
<a class="variable" href="#AeroParticle.mass">mass</a>
</li>
<li>
<a class="function" href="#AeroParticle.species_mass">species_mass</a>
</li>
<li>
<a class="variable" href="#AeroParticle.species_masses">species_masses</a>
</li>
<li>
<a class="variable" href="#AeroParticle.solute_kappa">solute_kappa</a>
</li>
<li>
<a class="variable" href="#AeroParticle.moles">moles</a>
</li>
<li>
<a class="variable" href="#AeroParticle.absorb_cross_sect">absorb_cross_sect</a>
</li>
<li>
<a class="variable" href="#AeroParticle.scatter_cross_sect">scatter_cross_sect</a>
</li>
<li>
<a class="variable" href="#AeroParticle.asymmetry">asymmetry</a>
</li>
<li>
<a class="variable" href="#AeroParticle.refract_shell">refract_shell</a>
</li>
<li>
<a class="variable" href="#AeroParticle.refract_core">refract_core</a>
</li>
<li>
<a class="variable" href="#AeroParticle.sources">sources</a>
</li>
<li>
<a class="variable" href="#AeroParticle.least_create_time">least_create_time</a>
</li>
<li>
<a class="variable" href="#AeroParticle.greatest_create_time">greatest_create_time</a>
</li>
<li>
<a class="variable" href="#AeroParticle.id">id</a>
</li>
<li>
<a class="function" href="#AeroParticle.mobility_diameter">mobility_diameter</a>
</li>
<li>
<a class="variable" href="#AeroParticle.density">density</a>
</li>
<li>
<a class="function" href="#AeroParticle.approx_crit_rel_humid">approx_crit_rel_humid</a>
</li>
<li>
<a class="function" href="#AeroParticle.crit_rel_humid">crit_rel_humid</a>
</li>
<li>
<a class="function" href="#AeroParticle.crit_diameter">crit_diameter</a>
</li>
<li>
<a class="function" href="#AeroParticle.coagulate">coagulate</a>
</li>
<li>
<a class="function" href="#AeroParticle.zero">zero</a>
</li>
<li>
<a class="function" href="#AeroParticle.set_vols">set_vols</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#BinGrid">BinGrid</a>
<ul class="memberlist">
<li>
<a class="function" href="#BinGrid.__init__">BinGrid</a>
</li>
<li>
<a class="variable" href="#BinGrid.edges">edges</a>
</li>
<li>
<a class="variable" href="#BinGrid.centers">centers</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#CampCore">CampCore</a>
<ul class="memberlist">
<li>
<a class="function" href="#CampCore.__init__">CampCore</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#EnvState">EnvState</a>
<ul class="memberlist">
<li>
<a class="function" href="#EnvState.__init__">EnvState</a>
</li>
<li>
<a class="function" href="#EnvState.set_temperature">set_temperature</a>
</li>
<li>
<a class="variable" href="#EnvState.temp">temp</a>
</li>
<li>
<a class="variable" href="#EnvState.rh">rh</a>
</li>
<li>
<a class="variable" href="#EnvState.elapsed_time">elapsed_time</a>
</li>
<li>
<a class="variable" href="#EnvState.start_time">start_time</a>
</li>
<li>
<a class="variable" href="#EnvState.height">height</a>
</li>
<li>
<a class="variable" href="#EnvState.pressure">pressure</a>
</li>
<li>
<a class="variable" href="#EnvState.air_density">air_density</a>
</li>
<li>
<a class="variable" href="#EnvState.additive_kernel_coefficient">additive_kernel_coefficient</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#GasData">GasData</a>
<ul class="memberlist">
<li>
<a class="function" href="#GasData.__init__">GasData</a>
</li>
<li>
<a class="variable" href="#GasData.n_spec">n_spec</a>
</li>
<li>
<a class="function" href="#GasData.spec_by_name">spec_by_name</a>
</li>
<li>
<a class="variable" href="#GasData.species">species</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#GasState">GasState</a>
<ul class="memberlist">
<li>
<a class="function" href="#GasState.__init__">GasState</a>
</li>
<li>
<a class="variable" href="#GasState.n_spec">n_spec</a>
</li>
<li>
<a class="function" href="#GasState.set_size">set_size</a>
</li>
<li>
<a class="function" href="#GasState.mix_rat">mix_rat</a>
</li>
<li>
<a class="variable" href="#GasState.mix_rats">mix_rats</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#Photolysis">Photolysis</a>
<ul class="memberlist">
<li>
<a class="function" href="#Photolysis.__init__">Photolysis</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#RunPartOpt">RunPartOpt</a>
<ul class="memberlist">
<li>
<a class="function" href="#RunPartOpt.__init__">RunPartOpt</a>
</li>
<li>
<a class="variable" href="#RunPartOpt.t_max">t_max</a>
</li>
<li>
<a class="variable" href="#RunPartOpt.del_t">del_t</a>
</li>
</ul>
</li>
<li>
<a class="class" href="#Scenario">Scenario</a>
<ul class="memberlist">
<li>
<a class="function" href="#Scenario.__init__">Scenario</a>
</li>
<li>
<a class="function" href="#Scenario.init_env_state">init_env_state</a>
</li>
<li>
<a class="function" href="#Scenario.aero_emissions">aero_emissions</a>
</li>
<li>
<a class="variable" href="#Scenario.aero_emissions_n_times">aero_emissions_n_times</a>
</li>
<li>
<a class="variable" href="#Scenario.aero_emissions_rate_scale">aero_emissions_rate_scale</a>
</li>
<li>
<a class="variable" href="#Scenario.aero_emissions_time">aero_emissions_time</a>
</li>
<li>
<a class="function" href="#Scenario.aero_background">aero_background</a>
</li>
<li>
<a class="variable" href="#Scenario.aero_dilution_n_times">aero_dilution_n_times</a>
</li>
<li>
<a class="variable" href="#Scenario.aero_dilution_rate">aero_dilution_rate</a>
</li>
<li>
<a class="variable" href="#Scenario.aero_dilution_time">aero_dilution_time</a>
</li>
</ul>
</li>
<li>
<a class="function" href="#condense_equilib_particles">condense_equilib_particles</a>
</li>
<li>
<a class="function" href="#run_part">run_part</a>
</li>
<li>
<a class="function" href="#run_part_timeblock">run_part_timeblock</a>
</li>
<li>
<a class="function" href="#run_part_timestep">run_part_timestep</a>
</li>
<li>
<a class="function" href="#pow2_above">pow2_above</a>
</li>
<li>
<a class="function" href="#condense_equilib_particle">condense_equilib_particle</a>
</li>
<li>
<a class="function" href="#histogram_1d">histogram_1d</a>
</li>
<li>
<a class="function" href="#histogram_2d">histogram_2d</a>
</li>
<li>
<a class="function" href="#sphere_vol2rad">sphere_vol2rad</a>
</li>
<li>
<a class="function" href="#rad2diam">rad2diam</a>
</li>
<li>
<a class="function" href="#sphere_rad2vol">sphere_rad2vol</a>
</li>
<li>
<a class="function" href="#diam2rad">diam2rad</a>
</li>
<li>
<a class="function" href="#loss_rate_dry_dep">loss_rate_dry_dep</a>
</li>
<li>
<a class="function" href="#loss_rate">loss_rate</a>
</li>
<li>
<a class="function" href="#output_state">output_state</a>
</li>
<li>
<a class="function" href="#input_state">input_state</a>
</li>
<li>
<a class="function" href="#rand_init">rand_init</a>
</li>
<li>
<a class="function" href="#rand_normal">rand_normal</a>
</li>
<li>
<a class="variable" href="#si">si</a>
</li>
</ul>
<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
alt="pdoc logo"
src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
</a>
</div>
</nav>
<main class="pdoc">
<section class="module-info">
<h1 class="modulename">
PyPartMC </h1>
<div class="docstring"><p><img src="https://raw.githubusercontent.com/wiki/open-atmos/PyPartMC/logo.svg" alt="logo" /></p>
<h1 id="pypartmc">PyPartMC</h1>
<p>PyPartMC is a Python interface to <a href="https://lagrange.mechse.illinois.edu/partmc/">PartMC</a>,
a particle-resolved Monte-Carlo code for atmospheric aerosol simulation.
Development of PyPartMC has been intended to remove limitations to the use of Fortran-implemented PartMC.
PyPartMC facilitates the dissemination of computational research results by streamlining independent execution
of PartMC simulations (also during peer-review processes).
Additionally, the ability to easily package examples, simple simulations, and results in a web-based notebook
allows PyPartMC to support the efforts of many members of the scientific community, including researchers,
instructors, and students, with nominal software and hardware requirements.</p>
<p>Documentation of PyPartMC is hosted at <a href="https://open-atmos.github.io/PyPartMC">https://open-atmos.github.io/PyPartMC</a>.
PyPartMC is implemented in C++ and it also constitutes a C++ API to the PartMC Fortran internals.
The Python API can facilitate using PartMC from other environments - see, e.g., Julia and Matlab examples below.</p>
<p>For an outline of the project, rationale, architecture, and features, refer to: <a href="https://doi.org/10.1016/j.softx.2023.101613">D'Aquino et al., 2024 (SoftwareX)</a> (please cite if PyPartMC is used in your research).
For a list of talks and other relevant resources, please see <a href="https://github.com/open-atmos/PyPartMC/wiki/">project Wiki</a>.
If interested in contributing to PyPartMC, please have a look a the <a href="https://github.com/open-atmos/PyPartMC/tree/main/CONTRIBUTING.md">notes for developers</a>.</p>
<p><a href="https://asr.science.energy.gov/"><img src="https://img.shields.io/static/v1?label=US%20DOE%20Funding%20by&color=267c32&message=ASR&logoWidth=25&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAQCAMAAAA25D/gAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAASFBMVEVOTXyyIjRDQnNZWINZWITtzdFUU4BVVIFVVYHWiZM9PG/KZnNXVoJaWYT67/FKSXhgX4hgX4lcW4VbWoX03uHQeIN2VXj///9pZChlAAAAAWJLR0QXC9aYjwAAAAd0SU1FB+EICRMGJV+KCCQAAABdSURBVBjThdBJDoAgEETRkkkZBBX0/kd11QTTpH1/STqpAAwWBkobSlkGbt0o5xmEfqxDZJB2Q6XMoBwnVSbTylWp0hi42rmbwTOYPDfR5Kc+07IIUQQvghX9THsBHcES8/SiF0kAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTctMDgtMDlUMTk6MDY6MzcrMDA6MDCX1tBgAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE3LTA4LTA5VDE5OjA2OjM3KzAwOjAw5oto3AAAAABJRU5ErkJggg==" alt="US Funding" /></a> <a href="https://www.ncn.gov.pl/?language=en"><img src="https://img.shields.io/static/v1?label=PL%20Funding%20by&color=d21132&message=NCN&logoWidth=25&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAANCAYAAACpUE5eAAAABmJLR0QA/wD/AP+gvaeTAAAAKUlEQVQ4jWP8////fwYqAiZqGjZqIHUAy4dJS6lqIOMdEZvRZDPcDQQAb3cIaY1Sbi4AAAAASUVORK5CYII=" alt="PL Funding" /></a></p>
<p><a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg" alt="License: GPL v3" /></a>
<a href="https://atmos.illinois.edu/"><img src="https://img.shields.io/static/v1?label=Copyright&color=249fe2&message=UIUC&" alt="Copyright" /></a>
<a href="https://github.com/open-atmos/PyPartMC/actions/workflows/tests+pypi.yml"><img src="https://github.com/open-atmos/PyPartMC/actions/workflows/tests+pypi.yml/badge.svg" alt="tests+pypi" /></a>
<a href="https://open-atmos.github.io/PyPartMC/"><img src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg" alt="API docs" /></a>
<a href="https://codecov.io/gh/open-atmos/PyPartMC"><img src="https://codecov.io/gh/open-atmos/PyPartMC/graph/badge.svg?token=27IK9ZIQXE" alt="codecov" /></a>
<a href="https://doi.org/10.5281/zenodo.7662635"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.7662635.svg" alt="DOI" /></a>
<a href="https://pypi.org/p/PyPartMC"><img src="https://badge.fury.io/py/PyPartMC.svg" alt="PyPI version" /></a>
<a href="https://www.repostatus.org/#active"><img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." /></a>
<a href="https://github.com/pyOpenSci/software-review/issues/179"><img src="https://pyopensci.org/badges/peer-reviewed.svg" alt="pyOpenSci Peer-Reviewed" /></a></p>
<p><a href="https://www.python.org/"><img src="https://img.shields.io/static/v1?label=Python&logo=Python&color=3776AB&message=3" alt="Python 3" /></a>
<a href="https://en.wikipedia.org/wiki/Linux"><img src="https://img.shields.io/static/v1?label=Linux&logo=Linux&color=yellow&message=%E2%9C%93" alt="Linux OK" /></a>
<a href="https://en.wikipedia.org/wiki/macOS"><img src="https://img.shields.io/static/v1?label=macOS&logo=Apple&color=silver&message=%E2%9C%93" alt="macOS OK" /></a>
<a href="https://en.wikipedia.org/wiki/Windows"><img src="https://img.shields.io/static/v1?label=Windows&logo=Windows&color=white&message=%E2%9C%93" alt="Windows OK" /></a>
<a href="https://jupyter.org/"><img src="https://img.shields.io/static/v1?label=Jupyter&logo=Jupyter&color=f37626&message=%E2%9C%93" alt="Jupyter" /></a></p>
<h2 id="installation">Installation</h2>
<h3 id="using-the-command-line-pip-tool-also-applies-to-conda-environments">Using the command-line <code>pip</code> tool (also applies to conda environments)</h3>
<div class="pdoc-code codehilite">
<pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>PyPartMC
</code></pre>
</div>
<p>Note that, depending on the environment (OS, hardware, Python version), the pip-install invocation
may either trigger a download of a pre-compiled binary, or trigger compilation of PyPartMC.
In the latter case, a Fortran compiler and some development tools includiong CMake, m4 and perl
are required (while all non-Python dependencies are included in the PyPartMC source archive).
In both cases, all Python dependencies will be resolved by pip.</p>
<h3 id="in-a-jupyter-notebook-cell-also-on-colab-or-jupyter-hub-instances">In a Jupyter notebook cell (also on Colab or jupyter-hub instances)</h3>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="err">!</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">PyPartMC</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">PyPartMC</span>
</code></pre>
</div>
<h4 id="jupyter-notebooks-with-examples">Jupyter notebooks with examples</h4>
<p>Note: clicking the badges below redirects to cloud-computing platforms. The mybinder.org links allow anonymous execution, Google Colab requires logging in with a Google account, ARM JupyerHub requires logging in with an ARM account (and directing Jupyter to a particular notebook within the <code>examples</code> folder).</p>
<p>The example notebooks feature additional dependencies that can be installed with:</p>
<div class="pdoc-code codehilite">
<pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>PyPartMC<span class="o">[</span>examples<span class="o">]</span>
</code></pre>
</div>
<ul>
<li>Urban plume scenario demo (as in <a href="https://github.com/compdyn/partmc/tree/master/scenarios/1_urban_plume">PartMC</a>):<br />
<a href="https://github.com/open-atmos/PyPartMC/blob/main/examples/particle_simulation.ipynb"><img src="https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub" alt="View notebook" /></a>
<a href="https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/particle_simulation.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/particle_simulation.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>
<a href="https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath="><img src="https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub" alt="ARM JupyterHub" /></a> </li>
<li>Dry-Wet Particle Size Equilibration with PartMC and PySDM:<br />
<a href="https://github.com/open-atmos/PyPartMC/blob/main/examples/lognorm_ex.ipynb"><img src="https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub" alt="View notebook" /></a>
<a href="https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/lognorm_ex.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/lognorm_ex.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>
<a href="https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath="><img src="https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub" alt="ARM JupyterHub" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC/main?urlpath=voila%2Frender%2Fexamples%2Flognorm_ex.ipynb"><img src="https://img.shields.io/static/v1?label=Voil%C3%A0&logo=jupyter&color=teal&message=web+app" alt="Voila" /></a></li>
<li>Simulation output processing example (loading from netCDF files using PyPartMC):<br />
<a href="https://github.com/open-atmos/PyPartMC/blob/main/examples/process_simulation_output.ipynb"><img src="https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub" alt="View notebook" /></a>
<a href="https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/process_simulation_output.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/process_simulation_output.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>
<a href="https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath="><img src="https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub" alt="ARM JupyterHub" /></a></li>
<li>Optical properties calculation using external Python package (<a href="https://pymiescatt.readthedocs.io/en/latest/">PyMieScatt</a>):<br />
<a href="https://github.com/open-atmos/PyPartMC/blob/main/examples/mie_optical.ipynb"><img src="https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub" alt="View notebook" /></a>
<a href="https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/mie_optical.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/mie_optical.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>
<a href="https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath="><img src="https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub" alt="ARM JupyterHub" /></a></li>
<li>Cloud parcel example featuring supersaturation-evolution-coupled CCN activation and drop growth:<br />
<a href="https://github.com/open-atmos/PyPartMC/blob/main/examples/cloud_parcel.ipynb"><img src="https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub" alt="View notebook" /></a>
<a href="https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/cloud_parcel.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/cloud_parcel.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>
<a href="https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath="><img src="https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub" alt="ARM JupyterHub" /></a></li>
<li>Coagulation Model Intercomparison with PySDM, Droplets.jl:<br />
<a href="https://github.com/open-atmos//PyPartMC/blob/main/examples/additive_coag_comparison.ipynb"><img src="https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub" alt="View notebook" /></a>
<a href="https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/additive_coag_comparison.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
<a href="https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/additive_coag_comparison.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>
<a href="https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath="><img src="https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub" alt="ARM JupyterHub" /></a> </li>
</ul>
<h2 id="features">Features</h2>
<ul>
<li>works on Linux, macOS and Windows (compatibility assured with <a href="https://github.com/open-atmos/PyPartMC/blob/main/.github/workflows/tests.yml">CI builds</a>)</li>
<li>hassle-free installation using <code>pip</code> (prior PartMC installation <strong>not needed</strong>)</li>
<li>works out of the box on <a href="https://mybinder.org/">mybinder.org</a>, <a href="colab.research.google.com/">Google Colab</a> and alike</li>
<li>ships with <a href="https://github.com/open-atmos/PyPartMC/tree/main/examples">a set of examples</a> maintained in a form of Jupyter notebooks</li>
<li>Pythonic API (but retaining PartMC jargon) incl. Python GC deallocation of Fortran objects</li>
<li>specification of parameters using native Python datatypes (lists, dicts) in place of PartMC spec files</li>
<li>code snippets in README depicting how to use PyPartMC from Julia and Matlab (also executed on CI)</li>
<li>auto-generated <a href="https://open-atmos.github.io/PyPartMC/">API docs on the web</a></li>
<li>support for [de]serialization of selected wrapped structures using JSON </li>
<li>based on <a href="https://github.com/open-atmos/PyPartMC/tree/main/gitmodules">unmodified PartMC code</a></li>
<li>does not use or require shell or any pre-installed libraries</li>
<li>aiming at 100% <a href="https://github.com/open-atmos/PyPartMC/tree/main/tests">unit test coverage</a></li>
</ul>
<h2 id="usage-examples">Usage examples</h2>
<p>The listings below depict how the identical task of randomly sampling particles from an aerosol size distribution in PartMC can be
done in different programming languages.</p>
<p>For a Fortran equivalent of the Python, Julia and Matlab programs below, see the <a href="https://github.com/open-atmos/PyPartMC/tree/main/readme_fortran"><code>readme_fortran</code> folder</a>.</p>
<h4 id="python">Python</h4>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">PyPartMC</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">ppmc</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">PyPartMC</span><span class="w"> </span><span class="kn">import</span> <span class="n">si</span>
<span class="n">aero_data</span> <span class="o">=</span> <span class="n">ppmc</span><span class="o">.</span><span class="n">AeroData</span><span class="p">((</span>
<span class="c1"># [density, ions in solution, molecular weight, kappa]</span>
<span class="p">{</span><span class="s2">"OC"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1000</span> <span class="o">*</span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">m</span><span class="o">**</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">1e-3</span> <span class="o">*</span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">mol</span><span class="p">,</span> <span class="mf">0.001</span><span class="p">]},</span>
<span class="p">{</span><span class="s2">"BC"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1800</span> <span class="o">*</span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">m</span><span class="o">**</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">1e-3</span> <span class="o">*</span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">mol</span><span class="p">,</span> <span class="mi">0</span><span class="p">]},</span>
<span class="p">))</span>
<span class="n">aero_dist</span> <span class="o">=</span> <span class="n">ppmc</span><span class="o">.</span><span class="n">AeroDist</span><span class="p">(</span>
<span class="n">aero_data</span><span class="p">,</span>
<span class="p">[{</span>
<span class="s2">"cooking"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"mass_frac"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"OC"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">]}],</span>
<span class="s2">"diam_type"</span><span class="p">:</span> <span class="s2">"geometric"</span><span class="p">,</span>
<span class="s2">"mode_type"</span><span class="p">:</span> <span class="s2">"log_normal"</span><span class="p">,</span>
<span class="s2">"num_conc"</span><span class="p">:</span> <span class="mi">3200</span> <span class="o">/</span> <span class="n">si</span><span class="o">.</span><span class="n">cm</span><span class="o">**</span><span class="mi">3</span><span class="p">,</span>
<span class="s2">"geom_mean_diam"</span><span class="p">:</span> <span class="mf">8.64</span> <span class="o">*</span> <span class="n">si</span><span class="o">.</span><span class="n">nm</span><span class="p">,</span>
<span class="s2">"log10_geom_std_dev"</span><span class="p">:</span> <span class="mf">0.28</span><span class="p">,</span>
<span class="p">},</span>
<span class="s2">"diesel"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"mass_frac"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"OC"</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">]},</span> <span class="p">{</span><span class="s2">"BC"</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.7</span><span class="p">]}],</span>
<span class="s2">"diam_type"</span><span class="p">:</span> <span class="s2">"geometric"</span><span class="p">,</span>
<span class="s2">"mode_type"</span><span class="p">:</span> <span class="s2">"log_normal"</span><span class="p">,</span>
<span class="s2">"num_conc"</span><span class="p">:</span> <span class="mi">2900</span> <span class="o">/</span> <span class="n">si</span><span class="o">.</span><span class="n">cm</span><span class="o">**</span><span class="mi">3</span><span class="p">,</span>
<span class="s2">"geom_mean_diam"</span><span class="p">:</span> <span class="mi">50</span> <span class="o">*</span> <span class="n">si</span><span class="o">.</span><span class="n">nm</span><span class="p">,</span>
<span class="s2">"log10_geom_std_dev"</span><span class="p">:</span> <span class="mf">0.24</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}],</span>
<span class="p">)</span>
<span class="n">n_part</span> <span class="o">=</span> <span class="mi">100</span>
<span class="n">aero_state</span> <span class="o">=</span> <span class="n">ppmc</span><span class="o">.</span><span class="n">AeroState</span><span class="p">(</span><span class="n">aero_data</span><span class="p">,</span> <span class="n">n_part</span><span class="p">,</span> <span class="s2">"nummass_source"</span><span class="p">)</span>
<span class="n">aero_state</span><span class="o">.</span><span class="n">dist_sample</span><span class="p">(</span><span class="n">aero_dist</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">dot</span><span class="p">(</span><span class="n">aero_state</span><span class="o">.</span><span class="n">masses</span><span class="p">(),</span> <span class="n">aero_state</span><span class="o">.</span><span class="n">num_concs</span><span class="p">),</span> <span class="s2">"# kg/m3"</span><span class="p">)</span>
</code></pre>
</div>
<h4 id="julia-using-pycalljlhttpsgithubcomjuliapypycalljl">Julia (using <a href="https://github.com/JuliaPy/PyCall.jl">PyCall.jl</a>)</h4>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="k">using</span><span class="w"> </span><span class="n">Pkg</span>
<span class="n">Pkg</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">"PyCall"</span><span class="p">)</span>
<span class="k">using</span><span class="w"> </span><span class="n">PyCall</span>
<span class="n">ppmc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">pyimport</span><span class="p">(</span><span class="s">"PyPartMC"</span><span class="p">)</span>
<span class="n">si</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ppmc</span><span class="p">[</span><span class="s">"si"</span><span class="p">]</span>
<span class="n">aero_data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ppmc</span><span class="o">.</span><span class="n">AeroData</span><span class="p">((</span>
<span class="w"> </span><span class="c"># (density, ions in solution, molecular weight, kappa)</span>
<span class="w"> </span><span class="kt">Dict</span><span class="p">(</span><span class="s">"OC"</span><span class="o">=></span><span class="p">(</span><span class="mi">1000</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">m</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mf">1e-3</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">mol</span><span class="p">,</span><span class="w"> </span><span class="mf">0.001</span><span class="p">)),</span>
<span class="w"> </span><span class="kt">Dict</span><span class="p">(</span><span class="s">"BC"</span><span class="o">=></span><span class="p">(</span><span class="mi">1800</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">m</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mf">1e-3</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="o">.</span><span class="n">mol</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">))</span>
<span class="p">))</span>
<span class="n">aero_dist</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ppmc</span><span class="o">.</span><span class="n">AeroDist</span><span class="p">(</span><span class="n">aero_data</span><span class="p">,</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="kt">Dict</span><span class="p">(</span><span class="w"> </span>
<span class="w"> </span><span class="s">"cooking"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="kt">Dict</span><span class="p">(</span>
<span class="w"> </span><span class="s">"mass_frac"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="p">(</span><span class="kt">Dict</span><span class="p">(</span><span class="s">"OC"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="p">(</span><span class="mi">1</span><span class="p">,)),),</span>
<span class="w"> </span><span class="s">"diam_type"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="s">"geometric"</span><span class="p">,</span>
<span class="w"> </span><span class="s">"mode_type"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="s">"log_normal"</span><span class="p">,</span>
<span class="w"> </span><span class="s">"num_conc"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="mi">3200</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">cm</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span>
<span class="w"> </span><span class="s">"geom_mean_diam"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="mf">8.64</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">nm</span><span class="p">,</span>
<span class="w"> </span><span class="s">"log10_geom_std_dev"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="mf">.28</span><span class="p">,</span>
<span class="w"> </span><span class="p">),</span>
<span class="w"> </span><span class="s">"diesel"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="kt">Dict</span><span class="p">(</span>
<span class="w"> </span><span class="s">"mass_frac"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="p">(</span><span class="kt">Dict</span><span class="p">(</span><span class="s">"OC"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="p">(</span><span class="mf">.3</span><span class="p">,)),</span><span class="w"> </span><span class="kt">Dict</span><span class="p">(</span><span class="s">"BC"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="p">(</span><span class="mf">.7</span><span class="p">,))),</span>
<span class="w"> </span><span class="s">"diam_type"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="s">"geometric"</span><span class="p">,</span>
<span class="w"> </span><span class="s">"mode_type"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="s">"log_normal"</span><span class="p">,</span>
<span class="w"> </span><span class="s">"num_conc"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="mi">2900</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">cm</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span>
<span class="w"> </span><span class="s">"geom_mean_diam"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="mi">50</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="o">.</span><span class="n">nm</span><span class="p">,</span>
<span class="w"> </span><span class="s">"log10_geom_std_dev"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="mf">.24</span><span class="p">,</span>
<span class="w"> </span><span class="p">)</span>
<span class="w"> </span><span class="p">),</span>
<span class="p">))</span>
<span class="n">n_part</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">100</span>
<span class="n">aero_state</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ppmc</span><span class="o">.</span><span class="n">AeroState</span><span class="p">(</span><span class="n">aero_data</span><span class="p">,</span><span class="w"> </span><span class="n">n_part</span><span class="p">,</span><span class="w"> </span><span class="s">"nummass_source"</span><span class="p">)</span>
<span class="n">aero_state</span><span class="o">.</span><span class="n">dist_sample</span><span class="p">(</span><span class="n">aero_dist</span><span class="p">)</span>
<span class="n">print</span><span class="p">(</span><span class="n">aero_state</span><span class="o">.</span><span class="n">masses</span><span class="p">()</span><span class="o">'</span><span class="n">aero_state</span><span class="o">.</span><span class="n">num_concs</span><span class="p">,</span><span class="w"> </span><span class="s">"# kg/m3"</span><span class="p">)</span>
</code></pre>
</div>
<h4 id="matlab-using-matlabs-built-in-python-interfacehttpswwwmathworkscomhelpmatlabpython-languagehtml">Matlab (using <a href="https://www.mathworks.com/help/matlab/python-language.html">Matlab's built-in Python interface</a>)</h4>
<p>notes (see the <a href="https://github.com/open-atmos/PyPartMC/blob/main/.github/workflows/readme_listings.yml">PyPartMC Matlab CI workflow</a> for an example on how to achieve it on Ubuntu 20):</p>
<ul>
<li>Matlab ships with convenience copies of C, C++ and Fortran runtime libraries which are <code>dlopened()</code> by default; one way to make PyPartMC OK with it is to [pip-]install by compiling from source using the very same version of GCC that Matlab borrowed these libraries from (e.g., <a href="https://www.mathworks.com/support/requirements/supported-compilers-linux.html">GCC 9 for Matlab R2022a, etc</a>);</li>
<li>Matlab needs to <a href="https://www.mathworks.com/support/requirements/python-compatibility.html">use the same Python interpretter/venv</a> as the pip invocation used to install PyPartMC;</li>
<li>a single-line <code>pybind11_builtins.py</code> file with just <code>pybind11_type=type</code> inside needs to be placed within Matlab's <code>PYTHONPATH</code> to sort out a <a href="https://github.com/pybind/pybind11/issues/3945">Matlab-pybind11 incompatibility</a>. </li>
</ul>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="n">ppmc</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">importlib</span><span class="p">.</span><span class="n">import_module</span><span class="p">(</span><span class="s">'PyPartMC'</span><span class="p">);</span>
<span class="n">si</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">importlib</span><span class="p">.</span><span class="n">import_module</span><span class="p">(</span><span class="s">'PyPartMC'</span><span class="p">).</span><span class="n">si</span><span class="p">;</span>
<span class="n">aero_data</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">ppmc</span><span class="p">.</span><span class="n">AeroData</span><span class="p">(</span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="s">"OC"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="mi">1000</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="p">.</span><span class="n">m</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mf">1e-3</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="p">.</span><span class="n">mol</span><span class="p">,</span><span class="w"> </span><span class="mf">0.001</span><span class="p">}))),</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="s">"BC"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="mi">1800</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="p">.</span><span class="n">m</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mf">1e-3</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">kg</span><span class="o">/</span><span class="n">si</span><span class="p">.</span><span class="n">mol</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">})))</span><span class="w"> </span><span class="k">...</span>
<span class="p">}));</span>
<span class="n">aero_dist</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">ppmc</span><span class="p">.</span><span class="n">AeroDist</span><span class="p">(</span><span class="n">aero_data</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"cooking"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"mass_frac"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="s">"OC"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="mi">1</span><span class="p">})))}),</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"diam_type"</span><span class="p">,</span><span class="w"> </span><span class="s">"geometric"</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"mode_type"</span><span class="p">,</span><span class="w"> </span><span class="s">"log_normal"</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"num_conc"</span><span class="p">,</span><span class="w"> </span><span class="mi">3200</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">cm</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"geom_mean_diam"</span><span class="p">,</span><span class="w"> </span><span class="mf">8.64</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">nm</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"log10_geom_std_dev"</span><span class="p">,</span><span class="w"> </span><span class="mf">.28</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="p">)),</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"diesel"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"mass_frac"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="s">"OC"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="mf">.3</span><span class="p">}))),</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">dict</span><span class="p">(</span><span class="nb">pyargs</span><span class="p">(</span><span class="s">"BC"</span><span class="p">,</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">tuple</span><span class="p">({</span><span class="mf">.7</span><span class="p">}))),</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="p">}),</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"diam_type"</span><span class="p">,</span><span class="w"> </span><span class="s">"geometric"</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"mode_type"</span><span class="p">,</span><span class="w"> </span><span class="s">"log_normal"</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"num_conc"</span><span class="p">,</span><span class="w"> </span><span class="mi">2900</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">cm</span><span class="o">^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"geom_mean_diam"</span><span class="p">,</span><span class="w"> </span><span class="mi">50</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">si</span><span class="p">.</span><span class="n">nm</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="s">"log10_geom_std_dev"</span><span class="p">,</span><span class="w"> </span><span class="mf">.24</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="p">))</span><span class="w"> </span><span class="k">...</span>
<span class="w"> </span><span class="p">))</span><span class="w"> </span><span class="k">...</span>
<span class="p">}));</span>
<span class="n">n_part</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">100</span><span class="p">;</span>
<span class="n">aero_state</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">ppmc</span><span class="p">.</span><span class="n">AeroState</span><span class="p">(</span><span class="n">aero_data</span><span class="p">,</span><span class="w"> </span><span class="n">n_part</span><span class="p">,</span><span class="w"> </span><span class="s">"nummass_source"</span><span class="p">);</span>
<span class="n">aero_state</span><span class="p">.</span><span class="n">dist_sample</span><span class="p">(</span><span class="n">aero_dist</span><span class="p">);</span>
<span class="n">masses</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="nb">cell</span><span class="p">(</span><span class="n">aero_state</span><span class="p">.</span><span class="n">masses</span><span class="p">());</span>
<span class="n">num_concs</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="nb">cell</span><span class="p">(</span><span class="n">aero_state</span><span class="p">.</span><span class="n">num_concs</span><span class="p">);</span>
<span class="nb">fprintf</span><span class="p">(</span><span class="s">'%g # kg/m3\n'</span><span class="p">,</span><span class="w"> </span><span class="nb">dot</span><span class="p">([</span><span class="n">masses</span><span class="p">{:}],</span><span class="w"> </span><span class="p">[</span><span class="n">num_concs</span><span class="p">{:}]))</span>
</code></pre>
</div>
<h4 id="usage-in-other-projects">usage in other projects</h4>
<p>PyPartMC is used within the <a href="https://github.com/atmos-cloud-sim-uj/PySDM/tree/main/tests/smoke_tests/box/partmc">test workflow of the PySDM project</a>.</p>
<h2 id="other-packages-with-relevant-feature-scope">Other packages with relevant feature scope</h2>
<ul>
<li><a href="https://openaerosol.sourceforge.io/">aerosolGDEFoam</a>: OpenFOAM CFD-coupled aerosol dynamics including nucleation, coagulation, and surface growth </li>
<li><a href="http://www.aiomfac.caltech.edu/">AIOMFAC and AIOMFAC-web</a>: Fortran-implemented aerosol thermodynamic model for calculation of activity coefficients in organic-inorganic mixtures – from simple binary solutions to complex multicomponent systems</li>
<li><a href="https://stammler.github.io/dustpy/">DustPy</a>: Python package for modelling dust evolution in protoplanetary disks (differences: focus on astrophysical applications vs. atmospheric aerosol)</li>
<li><a href="https://github.com/tintin554/multilayerpy">multilayerpy</a>: kinetic multi-layer model for aerosol particles and films </li>
<li><a href="https://pybox.readthedocs.io">PyBox</a>: aerosol simulation model featuring gas and particle chamistry (differences: PyBox focuses on chemical mechanisms; PyPartMC is an interface to PartMC which focuses on physics - e.g., collisions of aerosol particles - while chemical processes are handled with external software, e.g., CAMP or MOSAIC)</li>
<li><a href="https://github.com/simonom/PyCHAM">PyCHAM</a>: CHemistry with Aerosol Microphysics in Python Box Model for modelling of indoor environments, including aerosol chambers</li>
<li><a href="https://open-atmos.github.io/PySDM">PySDM</a>: particle-based Monte-Carlo aerosol-cloud simulation package (differences: PySDM focuses on growth and breakup processes relevant to cloud droplets; PyPartMC focuses on processes relevant to air pollutants and their chemical and physical transformations)</li>
<li><a href="https://github.com/sshaerosol/ssh-aerosol">SSH-aerosol</a>: C++/Fortran package for simulating evolution of primary and secondary atmospheric aerosols</li>
</ul>
<h2 id="faq">FAQ</h2>
<ul>
<li>Q: How to install PyPartMC with MOSAIC enabled?<br />
A: Installation can be done using <code>pip</code>, however, <code>pip</code> needs to be instructed not to use binary packages available at pypi.org but rather to compile from source (pip will download the source from pip.org), and the path to compiled MOSAIC library needs to be provided at compile-time; the following command should convey it:</li>
</ul>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="nv">MOSAIC_HOME</span><span class="o">=</span><span class="s"><<PATH_TO_MOSAIC_LIB>> pip install --force-reinstall --no-binary=P</span>yPartMC<span class="w"> </span>PyPartMC
</code></pre>
</div>
<ul>
<li><p>Q: Why <code>pip install PyPartMC</code> triggers compilation on my brand new Apple machine, while it quickly downloads and installs binary packages when executed on older Macs, Windows or Linux?<br />
A: We are providing binary wheels on PyPI for Apple-silicon (arm64) machines for selected macOS version made available by Github. In case the macOS version you are using is newer, compilation from source is triggered. </p></li>
<li><p>Q: Why some of the constructors expect data to be passed as <strong>lists of single-entry dictionaries</strong> instead of multi-element dictionaries?<br />
A: This is intentional and related with PartMC relying on the order of elements within spec-file input; while Python dictionaries preserve ordering (insertion order), JSON format does not, and we intend to make these data structures safe to be [de]serialized using JSON. </p></li>
<li><p>Q: How to check the version of PartMC that PyPartMC was compiled against?<br />
A: Version numbers of compile-time dependencies of PyPartMC, including PartMC, can be accessed as follows:</p></li>
</ul>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">PyPartMC</span>
<span class="n">PyPartMC</span><span class="o">.</span><span class="n">__versions_of_build_time_dependencies__</span><span class="p">[</span><span class="s1">'PartMC'</span><span class="p">]</span>
</code></pre>
</div>
<ul>
<li>Q: Why m4 and perl are required at compile time?<br />
A: PyPartMC includes parts of netCDF and HDF5 codebases which depend on m4 and perl, respectively, for generating source files before compilation.</li>
</ul>
<h2 id="troubleshooting">Troubleshooting</h2>
<h4 id="common-installation-issues">Common installation issues</h4>
<pre><code>error: [Errno 2] No such file or directory: 'cmake'
</code></pre>
<p>Try rerunning after installing CMake, e.g., using <code>apt-get install cmake</code> (Ubuntu/Debian), <code>brew install cmake</code> (homebrew on macOS) or using <a href="https://www.msys2.org/docs/cmake/">MSYS2</a> on Windows.</p>
<pre><code>No CMAKE_Fortran_COMPILER could be found.
</code></pre>
<p>Try installing a Fortran compiler (e.g., <code>brew reinstall gcc</code> with Homebrew on macOS or using <a href="https://packages.msys2.org/package/mingw-w64-x86_64-gcc-fortran?repo=mingw64">MSYS2</a> on Windows).</p>
<pre><code>Could not find NC_M4 using the following names: m4, m4.exe
</code></pre>
<p>Try installing <code>m4</code> (e.g., using <a href="https://packages.msys2.org/package/m4?repo=msys&variant=x86_64">MSYS2</a> on Windows).</p>
<h2 id="acknowledgement-and-citations">Acknowledgement and citations</h2>
<p>We would greatly appreciate citation of the PartMC model description paper (Riemer et al., 2009)
and the PyPartMC description paper (D’Aquino et al., 2024) if PyPartMC was used in your study.
The citations are:</p>
<ul>
<li>Riemer, N., M. West, R. A. Zaveri, R. C. Easter: Simulating the evolution of soot
mixing-state with a particle-resolved aerosol model<br />
J. Geophys. Res., 114, D09202, 2009, DOI: <a href="https://doi.org/10.1029/2008JD011073">10.1029/2008JD011073</a></li>
<li>D’Aquino, Z., S. Arabas, J. H. Curtis, A. Vaishnav, N. Riemer, M. West: PyPartMC: A
pythonic interfact to a particle-resolved, Monte Carlo aerosol simulation framework<br />
SoftwareX, 25, 101613, 2024, DOI: <a href="https://doi.org/10.1016/j.softx.2023.101613">10.1016/j.softx.2023.101613</a></li>
</ul>
<p>The following paragraph provides a more substantial description of PartMC (text released into the public domain and can be freely copied by anyone for any purpose):</p>
<blockquote>
<p>PartMC is a stochastic, particle-resolved aerosol box model. It tracks the
composition of many computational particles (10<sup>4</sup> to 10<sup>6</sup>) within a well-mixed air
volume, each represented by a composition vector that evolves based on physical
and chemical processes. The physical processes—including Brownian coagulation,
new particle formation, emissions, dilution, and deposition—are simulated using a
stochastic Monte Carlo approach via a Poisson process while chemical processes are
simulated deterministically for each computational particle. The weighted flow
algorithm (DeVille, Riemer, and West, 2011, 2019) enhances efficiency and reduces
ensemble variance. Detailed numerical methods are described in Riemer et al.
(2009), DeVille et al. (2011, 2019), and Curtis et al. (2016). PartMC is open-source
under the GNU GPL v2 and available at
<a href="https://github.com/compdyn/partmc">github.com/compdyn/partmc</a>.</p>
<p>References:</p>
<ul>
<li>Curtis, J. H., M. D. Michelotti, N. Riemer, M. T. Heath, M. West: Accelerated
simulation of stochastic particle removal processes in particle-resolved aerosol
models, J. Computational Phys., 322, 21-32, 2016, DOI: <a href="https://doi.org/10.1016/j.jcp.2016.06.029">10.1016/j.jcp.2016.06.029</a></li>
<li>DeVille, L., N. Riemer, M. West, Convergence of a generalized weighted flow
algorithm for stochastic particle coagulation, J. Computational Dynamics, 6, 69-94,
2019, DOI: <a href="https://doi.org/10.3934/jcd.2019003">10.3934/jcd.2019003</a></li>
<li>DeVille, R. E. L., N. Riemer, M. West, The Weighted Flow Algorithm (WFA) for
stochastic particle coagulation, J. Computational Phys., 230, 8427-8451, 2011,
DOI: <a href="https://doi.org/10.1016/j.jcp.2011.07.027">10.1016/j.jcp.2011.07.027</a></li>
<li>Riemer, N., M. West, R. A. Zaveri, R. C. Easter, Simulating the evolution of soot
mixing-state with a particle-resolved aerosol model, J. Geophys. Res., 114, D09202,
2009., DOI: <a href="https://doi.org/10.1029/2008JD011073">10.1029/2008JD011073</a></li>
</ul>
</blockquote>
<h2 id="credits">Credits</h2>
<h4 id="pypartmc-2">PyPartMC:</h4>
<p>authors: <a href="https://github.com/open-atmos/PyPartMC/graphs/contributors">PyPartMC developers</a><br />
funding: <a href="https://asr.science.energy.gov/">US Department of Energy Atmospheric System Research programme</a>, <a href="https://ncn.gov.pl/en">Polish National Science Centre</a><br />
copyright: <a href="https://atmos.illinois.edu/">University of Illinois at Urbana-Champaign</a><br />
licence: <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL v3</a></p>
<h4 id="partmc">PartMC:</h4>
<p>authors: <a href="https://www.atmos.uiuc.edu/~nriemer/">Nicole Riemer</a>, <a href="https://lagrange.mechse.illinois.edu/mwest/">Matthew West</a>, <a href="https://publish.illinois.edu/jcurtis2/">Jeff Curtis</a> et al.<br />
licence: <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GPL v2</a> or later</p>
</div>
<input id="mod-PyPartMC-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<label class="view-source-button" for="mod-PyPartMC-view-source"><span>View Source</span></label>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="sd">"""</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a><span class="sd">.. include::../README.md</span>
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="sd">"""</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a>
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a><span class="c1"># pylint: disable=invalid-name,wrong-import-position</span>
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">namedtuple</span>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">contextlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">contextmanager</span>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a>
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a>
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a><span class="c1"># https://github.com/diegoferigo/cmake-build-extension/blob/master/src/cmake_build_extension/__init__.py</span>
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="nd">@contextmanager</span>
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a><span class="k">def</span><span class="w"> </span><span class="nf">__build_extension_env</span><span class="p">():</span>
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a> <span class="n">cookies</span> <span class="o">=</span> <span class="p">[]</span>
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a> <span class="c1"># https://docs.python.org/3/whatsnew/3.8.html#bpo-36085-whatsnew</span>
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">os</span><span class="p">,</span> <span class="s2">"add_dll_directory"</span><span class="p">):</span>
</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a> <span class="n">basepath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a> <span class="n">dllspath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">basepath</span><span class="p">,</span> <span class="s2">".."</span><span class="p">)</span>
</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"PATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">dllspath</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">pathsep</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"PATH"</span><span class="p">]</span>
</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"PATH"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
</span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a> <span class="k">if</span> <span class="n">path</span> <span class="ow">and</span> <span class="n">Path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span> <span class="ow">and</span> <span class="n">Path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
</span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a> <span class="n">cookies</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">add_dll_directory</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a> <span class="k">try</span><span class="p">:</span>
</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a> <span class="k">yield</span>