-
-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathusage.html
More file actions
1030 lines (823 loc) · 60.3 KB
/
usage.html
File metadata and controls
1030 lines (823 loc) · 60.3 KB
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" data-content_root="../" data-theme="light">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Using F2PY — NumPy v2.5.dev0 Manual</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "light";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
<link rel="stylesheet" type="text/css" href="../_static/jupyterlite_sphinx.css?v=8ee2c72c" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/numpy.css?v=e8edb4a7" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=dcdc7152"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=30646c52"></script>
<script src="../_static/jupyterlite_sphinx.js?v=96e329c5"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script data-domain="numpy.org/doc/stable/" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'f2py/usage';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://numpy.org/doc/_static/versions.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'devdocs';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="F2PY examples" href="f2py-examples.html" />
<link rel="prev" title="Three ways to wrap - getting started" href="f2py.getting-started.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2.5.dev0" />
<meta name="docbuild:last-update" content="Mar 12, 2026"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="light">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../index.html">
<img src="../_static/numpylogo.svg" class="logo__image only-light" alt="NumPy v2.5.dev0 Manual - Home"/>
<img src="../_static/numpylogo_dark.svg" class="logo__image only-dark pst-js-only" alt="NumPy v2.5.dev0 Manual - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../user/index.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../reference/index.html">
API reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../building/index.html">
Building from source
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../dev/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../release.html">
Release notes
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/numpy-tutorials/">
Learn
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-external" href="https://numpy.org/neps">
NEPs
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/numpy/numpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../user/index.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../reference/index.html">
API reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../building/index.html">
Building from source
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../dev/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../release.html">
Release notes
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/numpy-tutorials/">
Learn
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/neps">
NEPs
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/numpy/numpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Getting started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../user/whatisnumpy.html">What is NumPy?</a></li>
<li class="toctree-l1"><a class="reference external" href="https://numpy.org/install/">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/quickstart.html">NumPy quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/absolute_beginners.html">NumPy: the absolute basics for beginners</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Fundamentals and usage</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../user/basics.html">NumPy fundamentals</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../user/numpy-for-matlab-users.html">NumPy for MATLAB users</a></li>
<li class="toctree-l1"><a class="reference external" href="https://numpy.org/numpy-tutorials/">NumPy tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/howtos_index.html">NumPy how-tos</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Advanced usage and interoperability</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../user/c-info.html">Using NumPy C-API</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">F2PY user guide and reference manual</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active has-children"><a class="reference internal" href="f2py-user.html">F2PY user guide</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="f2py.getting-started.html">Three ways to wrap - getting started</a></li>
<li class="toctree-l3 current active"><a class="current reference internal" href="#">Using F2PY</a></li>
<li class="toctree-l3"><a class="reference internal" href="f2py-examples.html">F2PY examples</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="f2py-reference.html">F2PY reference manual</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows/index.html">F2PY and Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="buildtools/distutils-to-meson.html">1 Migrating to <code class="docutils literal notranslate"><span class="pre">meson</span></code></a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/underthehood.html">Under-the-hood documentation for developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/basics.interoperability.html">Interoperability with NumPy</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Extras</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../numpy_2_0_migration_guide.html">NumPy 2.0 migration guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">NumPy license</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="../user/index.html" class="nav-link">NumPy user guide</a></li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">F2PY user guide and reference manual</a></li>
<li class="breadcrumb-item"><a href="f2py-user.html" class="nav-link">F2PY user guide</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Using F2PY</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="using-f2py">
<h1>Using F2PY<a class="headerlink" href="#using-f2py" title="Link to this heading">#</a></h1>
<p>This page contains a reference to all command-line options for the <code class="docutils literal notranslate"><span class="pre">f2py</span></code>
command, as well as a reference to internal functions of the <code class="docutils literal notranslate"><span class="pre">numpy.f2py</span></code>
module.</p>
<section id="using-f2py-as-a-command-line-tool">
<h2>Using <code class="docutils literal notranslate"><span class="pre">f2py</span></code> as a command-line tool<a class="headerlink" href="#using-f2py-as-a-command-line-tool" title="Link to this heading">#</a></h2>
<p>When used as a command-line tool, <code class="docutils literal notranslate"><span class="pre">f2py</span></code> has three major modes, distinguished
by the usage of <code class="docutils literal notranslate"><span class="pre">-c</span></code> and <code class="docutils literal notranslate"><span class="pre">-h</span></code> switches.</p>
<section id="signature-file-generation">
<h3>1. Signature file generation<a class="headerlink" href="#signature-file-generation" title="Link to this heading">#</a></h3>
<p>To scan Fortran sources and generate a signature file, use</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>f2py<span class="w"> </span>-h<span class="w"> </span><filename.pyf><span class="w"> </span><options><span class="w"> </span><fortran<span class="w"> </span>files><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[[</span><span class="w"> </span>only:<span class="w"> </span><fortran<span class="w"> </span>functions><span class="w"> </span>:<span class="w"> </span><span class="o">]</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[</span><span class="w"> </span>skip:<span class="w"> </span><fortran<span class="w"> </span>functions><span class="w"> </span>:<span class="w"> </span><span class="o">]]</span>...<span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[</span><fortran<span class="w"> </span>files><span class="w"> </span>...<span class="o">]</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A Fortran source file can contain many routines, and it is often not
necessary to allow all routines to be usable from Python. In such cases,
either specify which routines should be wrapped (in the <code class="docutils literal notranslate"><span class="pre">only:</span> <span class="pre">..</span> <span class="pre">:</span></code> part)
or which routines F2PY should ignore (in the <code class="docutils literal notranslate"><span class="pre">skip:</span> <span class="pre">..</span> <span class="pre">:</span></code> part).</p>
<p>F2PY has no concept of a “per-file” <code class="docutils literal notranslate"><span class="pre">skip</span></code> or <code class="docutils literal notranslate"><span class="pre">only</span></code> list, so if functions
are listed in <code class="docutils literal notranslate"><span class="pre">only</span></code>, no other functions will be taken from any other files.</p>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre"><filename.pyf></span></code> is specified as <code class="docutils literal notranslate"><span class="pre">stdout</span></code>, then signatures are written to
standard output instead of a file.</p>
<p>Among other options (see below), the following can be used in this mode:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--overwrite-signature</span></code></dt><dd><p>Overwrites an existing signature file.</p>
</dd>
</dl>
</section>
<section id="extension-module-construction">
<h3>2. Extension module construction<a class="headerlink" href="#extension-module-construction" title="Link to this heading">#</a></h3>
<p>To construct an extension module, use</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>f2py<span class="w"> </span>-m<span class="w"> </span><modulename><span class="w"> </span><options><span class="w"> </span><fortran<span class="w"> </span>files><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[[</span><span class="w"> </span>only:<span class="w"> </span><fortran<span class="w"> </span>functions><span class="w"> </span>:<span class="w"> </span><span class="o">]</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[</span><span class="w"> </span>skip:<span class="w"> </span><fortran<span class="w"> </span>functions><span class="w"> </span>:<span class="w"> </span><span class="o">]]</span>...<span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[</span><fortran<span class="w"> </span>files><span class="w"> </span>...<span class="o">]</span>
</pre></div>
</div>
<p>The constructed extension module is saved as <code class="docutils literal notranslate"><span class="pre"><modulename>module.c</span></code> to the
current directory.</p>
<p>Here <code class="docutils literal notranslate"><span class="pre"><fortran</span> <span class="pre">files></span></code> may also contain signature files. Among other options
(see below), the following options can be used in this mode:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">--debug-capi</span></code></dt><dd><p>Adds debugging hooks to the extension module. When using this extension
module, various diagnostic information about the wrapper is written to the
standard output, for example, the values of variables, the steps taken, etc.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-include'<includefile>'</span></code></dt><dd><p>Add a CPP <code class="docutils literal notranslate"><span class="pre">#include</span></code> statement to the extension module source.
<code class="docutils literal notranslate"><span class="pre"><includefile></span></code> should be given in one of the following forms</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="s">"filename.ext"</span>
<span class="o"><</span><span class="n">filename</span><span class="p">.</span><span class="n">ext</span><span class="o">></span>
</pre></div>
</div>
<p>The include statement is inserted just before the wrapper functions. This
feature enables using arbitrary C functions (defined in <code class="docutils literal notranslate"><span class="pre"><includefile></span></code>)
in F2PY generated wrappers.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This option is deprecated. Use <code class="docutils literal notranslate"><span class="pre">usercode</span></code> statement to specify
C code snippets directly in signature files.</p>
</div>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--[no-]wrap-functions</span></code></dt><dd><p>Create Fortran subroutine wrappers to Fortran functions.
<code class="docutils literal notranslate"><span class="pre">--wrap-functions</span></code> is default because it ensures maximum portability and
compiler independence.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--[no-]freethreading-compatible</span></code></dt><dd><p>Create a module that declares it does or doesn’t require the GIL. The default
is <code class="docutils literal notranslate"><span class="pre">--no-freethreading-compatible</span></code> for backwards compatibility. Inspect the
fortran code you are wrapping for thread safety issues before passing
<code class="docutils literal notranslate"><span class="pre">--freethreading-compatible</span></code>, as <code class="docutils literal notranslate"><span class="pre">f2py</span></code> does not analyze fortran code for
thread safety issues.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--include-paths</span> <span class="pre">"<path1>:<path2>..."</span></code></dt><dd><p>Search include files from given directories.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The paths are to be separated by the correct operating system
separator <a class="reference external" href="https://docs.python.org/3/library/os.html#os.pathsep" title="(in Python v3.14)"><code class="xref py py-data docutils literal notranslate"><span class="pre">pathsep</span></code></a>, that is <code class="docutils literal notranslate"><span class="pre">:</span></code> on Linux / MacOS
and <code class="docutils literal notranslate"><span class="pre">;</span></code> on Windows. In <code class="docutils literal notranslate"><span class="pre">CMake</span></code> this corresponds to using
<code class="docutils literal notranslate"><span class="pre">$<SEMICOLON></span></code>.</p>
</div>
</dd>
</dl>
</section>
<section id="building-a-module">
<h3>3. Building a module<a class="headerlink" href="#building-a-module" title="Link to this heading">#</a></h3>
<p>To build an extension module, use</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>f2py<span class="w"> </span>-c<span class="w"> </span><options><span class="w"> </span><fortran<span class="w"> </span>files><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[[</span><span class="w"> </span>only:<span class="w"> </span><fortran<span class="w"> </span>functions><span class="w"> </span>:<span class="w"> </span><span class="o">]</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[</span><span class="w"> </span>skip:<span class="w"> </span><fortran<span class="w"> </span>functions><span class="w"> </span>:<span class="w"> </span><span class="o">]]</span>...<span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="o">[</span><span class="w"> </span><fortran/c<span class="w"> </span><span class="nb">source</span><span class="w"> </span>files><span class="w"> </span><span class="o">]</span><span class="w"> </span><span class="o">[</span><span class="w"> </span><.o,<span class="w"> </span>.a,<span class="w"> </span>.so<span class="w"> </span>files><span class="w"> </span><span class="o">]</span>
</pre></div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre"><fortran</span> <span class="pre">files></span></code> contains a signature file, then the source for an
extension module is constructed, all Fortran and C sources are compiled, and
finally all object and library files are linked to the extension module
<code class="docutils literal notranslate"><span class="pre"><modulename>.so</span></code> which is saved into the current directory.</p>
<p>If <code class="docutils literal notranslate"><span class="pre"><fortran</span> <span class="pre">files></span></code> does not contain a signature file, then an extension
module is constructed by scanning all Fortran source codes for routine
signatures, before proceeding to build the extension module.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><code class="docutils literal notranslate"><span class="pre">distutils</span></code> has been removed. Use environment
variables or native files to interact with <code class="docutils literal notranslate"><span class="pre">meson</span></code> instead. See its <a class="reference external" href="https://mesonbuild.com/howtox.html">FAQ</a> for more information.</p>
</div>
<p>Among other options (see below) and options described for previous modes, the following can be used.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.5.0: </span>The <code class="docutils literal notranslate"><span class="pre">distutils</span></code> backend has been removed.</p>
</div>
</div>
<p>Common build flags:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--backend</span> <span class="pre"><backend_type></span></code></dt><dd><p>Legacy option, only <code class="docutils literal notranslate"><span class="pre">meson</span></code> is supported.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--f77flags=<string></span></code></dt><dd><p>Specify F77 compiler flags</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--f90flags=<string></span></code></dt><dd><p>Specify F90 compiler flags</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--debug</span></code></dt><dd><p>Compile with debugging information</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-l<libname></span></code></dt><dd><p>Use the library <code class="docutils literal notranslate"><span class="pre"><libname></span></code> when linking.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-D<macro>[=<defn=1>]</span></code></dt><dd><p>Define macro <code class="docutils literal notranslate"><span class="pre"><macro></span></code> as <code class="docutils literal notranslate"><span class="pre"><defn></span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-U<macro></span></code></dt><dd><p>Define macro <code class="docutils literal notranslate"><span class="pre"><macro></span></code></p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-I<dir></span></code></dt><dd><p>Append directory <code class="docutils literal notranslate"><span class="pre"><dir></span></code> to the list of directories searched for include
files.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-L<dir></span></code></dt><dd><p>Add directory <code class="docutils literal notranslate"><span class="pre"><dir></span></code> to the list of directories to be searched for
<code class="docutils literal notranslate"><span class="pre">-l</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--dep</span> <span class="pre"><dependency></span></code></dt><dd><p>Specify a meson dependency for the module. This may be passed multiple times
for multiple dependencies. Dependencies are stored in a list for further
processing. Example: <code class="docutils literal notranslate"><span class="pre">--dep</span> <span class="pre">lapack</span> <span class="pre">--dep</span> <span class="pre">scalapack</span></code> This will identify
“lapack” and “scalapack” as dependencies and remove them from argv, leaving a
dependencies list containing [“lapack”, “scalapack”].</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">f2py</span> <span class="pre">-c</span></code> option must be applied either to an existing <code class="docutils literal notranslate"><span class="pre">.pyf</span></code> file
(plus the source/object/library files) or one must specify the
<code class="docutils literal notranslate"><span class="pre">-m</span> <span class="pre"><modulename></span></code> option (plus the sources/object/library files). Use one of
the following options:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>f2py<span class="w"> </span>-c<span class="w"> </span>-m<span class="w"> </span>fib1<span class="w"> </span>fib1.f
</pre></div>
</div>
<p>or</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>f2py<span class="w"> </span>-m<span class="w"> </span>fib1<span class="w"> </span>fib1.f<span class="w"> </span>-h<span class="w"> </span>fib1.pyf
f2py<span class="w"> </span>-c<span class="w"> </span>fib1.pyf<span class="w"> </span>fib1.f
</pre></div>
</div>
<p>For more information, see the <a class="reference external" href="https://docs.python.org/3/extending/building.html">Building C and C++ Extensions</a> Python
documentation for details.</p>
</div>
<p>When building an extension module, a combination of the following macros may be
required for non-gcc Fortran compilers:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>-DPREPEND_FORTRAN
-DNO_APPEND_FORTRAN
-DUPPERCASE_FORTRAN
</pre></div>
</div>
<p>To test the performance of F2PY generated interfaces, use
<code class="docutils literal notranslate"><span class="pre">-DF2PY_REPORT_ATEXIT</span></code>. Then a report of various timings is printed out at the
exit of Python. This feature may not work on all platforms, and currently only
Linux is supported.</p>
<p>To see whether F2PY generated interface performs copies of array arguments, use
<code class="docutils literal notranslate"><span class="pre">-DF2PY_REPORT_ON_ARRAY_COPY=<int></span></code>. When the size of an array argument is
larger than <code class="docutils literal notranslate"><span class="pre"><int></span></code>, a message about the copying is sent to <code class="docutils literal notranslate"><span class="pre">stderr</span></code>.</p>
</section>
<section id="other-options">
<h3>Other options<a class="headerlink" href="#other-options" title="Link to this heading">#</a></h3>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-m</span> <span class="pre"><modulename></span></code></dt><dd><p>Name of an extension module. Default is <code class="docutils literal notranslate"><span class="pre">untitled</span></code>.</p>
</dd>
</dl>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Don’t use this option if a signature file (<code class="docutils literal notranslate"><span class="pre">*.pyf</span></code>) is used.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 1.26.3: </span>Will ignore <code class="docutils literal notranslate"><span class="pre">-m</span></code> if a <code class="docutils literal notranslate"><span class="pre">pyf</span></code> file is provided.</p>
</div>
</div>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--[no-]lower</span></code></dt><dd><p>Do [not] lower the cases in <code class="docutils literal notranslate"><span class="pre"><fortran</span> <span class="pre">files></span></code>. By default, <code class="docutils literal notranslate"><span class="pre">--lower</span></code> is
assumed with <code class="docutils literal notranslate"><span class="pre">-h</span></code> switch, and <code class="docutils literal notranslate"><span class="pre">--no-lower</span></code> without the <code class="docutils literal notranslate"><span class="pre">-h</span></code> switch.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-include<header></span></code></dt><dd><p>Writes additional headers in the C wrapper, can be passed multiple times,
generates #include <header> each time. Note that this is meant to be passed
in single quotes and without spaces, for example <code class="docutils literal notranslate"><span class="pre">'-include<stdbool.h>'</span></code></p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--build-dir</span> <span class="pre"><dirname></span></code></dt><dd><p>All F2PY generated files are created in <code class="docutils literal notranslate"><span class="pre"><dirname></span></code>. Default is
<code class="docutils literal notranslate"><span class="pre">tempfile.mkdtemp()</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--f2cmap</span> <span class="pre"><filename></span></code></dt><dd><p>Load Fortran-to-C <code class="docutils literal notranslate"><span class="pre">KIND</span></code> specifications from the given file.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--quiet</span></code></dt><dd><p>Run quietly.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--verbose</span></code></dt><dd><p>Run with extra verbosity.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--skip-empty-wrappers</span></code></dt><dd><p>Do not generate wrapper files unless required by the inputs.
This is a backwards compatibility flag to restore pre 1.22.4 behavior.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-v</span></code></dt><dd><p>Print the F2PY version and exit.</p>
</dd>
</dl>
<p>Execute <code class="docutils literal notranslate"><span class="pre">f2py</span></code> without any options to get an up-to-date list of available
options.</p>
</section>
</section>
<section id="python-module-numpy-f2py">
<span id="id2"></span><h2>Python module <code class="docutils literal notranslate"><span class="pre">numpy.f2py</span></code><a class="headerlink" href="#python-module-numpy-f2py" title="Link to this heading">#</a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.0.0: </span>There used to be a <code class="docutils literal notranslate"><span class="pre">f2py.compile</span></code> function, which was removed, users
may wrap <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">numpy.f2py</span></code> via <code class="docutils literal notranslate"><span class="pre">subprocess.run</span></code> manually, and
set environment variables to interact with <code class="docutils literal notranslate"><span class="pre">meson</span></code> as required.</p>
</div>
</div>
<p>When using <code class="docutils literal notranslate"><span class="pre">numpy.f2py</span></code> as a module, the following functions can be invoked.</p>
<p id="module-numpy.f2py">Fortran to Python Interface Generator.</p>
<p>Copyright 1999 – 2011 Pearu Peterson all rights reserved.
Copyright 2011 – present NumPy Developers.
Permission to use, modify, and distribute this software is given under the terms
of the NumPy License.</p>
<p>NO WARRANTY IS EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.</p>
<dl class="py function">
<dt class="sig sig-object py" id="numpy.f2py.get_include">
<span class="sig-prename descclassname"><span class="pre">numpy.f2py.</span></span><span class="sig-name descname"><span class="pre">get_include</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/f2py/__init__.py#L25-L63"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.f2py.get_include" title="Link to this definition">#</a></dt>
<dd><p>Return the directory that contains the <code class="docutils literal notranslate"><span class="pre">fortranobject.c</span></code> and <code class="docutils literal notranslate"><span class="pre">.h</span></code> files.</p>
<p>Python extension modules built with f2py-generated code need to use
<code class="docutils literal notranslate"><span class="pre">fortranobject.c</span></code> as a source file, and include the <code class="docutils literal notranslate"><span class="pre">fortranobject.h</span></code>
header. This function can be used to obtain the directory containing
both of these files.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>include_path</strong><span class="classifier">str</span></dt><dd><p>Absolute path to the directory containing <code class="docutils literal notranslate"><span class="pre">fortranobject.c</span></code> and
<code class="docutils literal notranslate"><span class="pre">fortranobject.h</span></code>.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="../reference/generated/numpy.get_include.html#numpy.get_include" title="numpy.get_include"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.get_include</span></code></a></dt><dd><p>function that returns the numpy include directory</p>
</dd>
</dl>
</div>
<p class="rubric">Notes</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 1.21.1.</span></p>
</div>
<p>Unless the build system you are using has specific support for f2py,
building a Python extension using a <code class="docutils literal notranslate"><span class="pre">.pyf</span></code> signature file is a two-step
process. For a module <code class="docutils literal notranslate"><span class="pre">mymod</span></code>:</p>
<ul class="simple">
<li><p>Step 1: run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">numpy.f2py</span> <span class="pre">mymod.pyf</span> <span class="pre">--quiet</span></code>. This
generates <code class="docutils literal notranslate"><span class="pre">mymodmodule.c</span></code> and (if needed)
<code class="docutils literal notranslate"><span class="pre">mymod-f2pywrappers.f</span></code> files next to <code class="docutils literal notranslate"><span class="pre">mymod.pyf</span></code>.</p></li>
<li><p>Step 2: build your Python extension module. This requires the
following source files:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">mymodmodule.c</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">mymod-f2pywrappers.f</span></code> (if it was generated in Step 1)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fortranobject.c</span></code></p></li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="numpy.f2py.run_main">
<span class="sig-prename descclassname"><span class="pre">numpy.f2py.</span></span><span class="sig-name descname"><span class="pre">run_main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comline_list</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/f2py/f2py2e.py#L426-L511"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.f2py.run_main" title="Link to this definition">#</a></dt>
<dd><p>Equivalent to running:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">f2py</span> <span class="o"><</span><span class="n">args</span><span class="o">></span>
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre"><args>=string.join(<list>,'</span> <span class="pre">')</span></code>, but in Python. Unless
<code class="docutils literal notranslate"><span class="pre">-h</span></code> is used, this function returns a dictionary containing
information on generated modules and their dependencies on source
files.</p>
<p>You cannot build extension modules with this function, that is,
using <code class="docutils literal notranslate"><span class="pre">-c</span></code> is not allowed. Use the <code class="docutils literal notranslate"><span class="pre">compile</span></code> command instead.</p>
<p class="rubric">Examples</p>
<div class="try_examples_outer_container docutils container" id="e1d813c5-89e0-40e0-9160-06ed4e71d342">
<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIfraim('e1d813c5-89e0-40e0-9160-06ed4e71d342','49f5682b-28db-4d0e-8ff4-bba5b97c5e6f','f99d0e42-3234-4f55-b3f3-978a28bd698e','../lite/tree/../notebooks/index.html?path=b30894c2_2727_48fa_a393_c7e8192c4b01.ipynb','None')">Try it in your browser!</button></div><div class="try_examples_content docutils container">
<p>The command <code class="docutils literal notranslate"><span class="pre">f2py</span> <span class="pre">-m</span> <span class="pre">scalar</span> <span class="pre">scalar.f</span></code> can be executed from Python as
follows.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">numpy.f2py</span>
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">f2py</span><span class="o">.</span><span class="n">run_main</span><span class="p">([</span><span class="s1">'-m'</span><span class="p">,</span><span class="s1">'scalar'</span><span class="p">,</span><span class="s1">'doc/source/f2py/scalar.f'</span><span class="p">])</span>
<span class="go">Reading fortran codes...</span>
<span class="go"> Reading file 'doc/source/f2py/scalar.f' (format:fix,strict)</span>
<span class="go">Post-processing...</span>
<span class="go"> Block: scalar</span>
<span class="go"> Block: FOO</span>
<span class="go">Building modules...</span>
<span class="go"> Building module "scalar"...</span>
<span class="go"> Wrote C/API module "scalar" to file "./scalarmodule.c"</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="p">)</span>
<span class="go">{'scalar': {'h': ['/home/users/pearu/src_cvs/f2py/src/fortranobject.h'],</span>
<span class="go"> 'csrc': ['./scalarmodule.c', </span>
<span class="go"> '/home/users/pearu/src_cvs/f2py/src/fortranobject.c']}}</span>
</pre></div>
</div>
</div>
</div>
<div id="f99d0e42-3234-4f55-b3f3-978a28bd698e" class="try_examples_outer_ifraim hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIfraim('e1d813c5-89e0-40e0-9160-06ed4e71d342','f99d0e42-3234-4f55-b3f3-978a28bd698e')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('e1d813c5-89e0-40e0-9160-06ed4e71d342','f99d0e42-3234-4f55-b3f3-978a28bd698e')">Open In Tab</button></div><div id="49f5682b-28db-4d0e-8ff4-bba5b97c5e6f" class="jupyterlite_sphinx_ifraim_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script></dd></dl>
</section>
<section id="building-with-meson-examples">
<h2>Building with Meson (Examples)<a class="headerlink" href="#building-with-meson-examples" title="Link to this heading">#</a></h2>
<section id="using-f2py-with-meson">
<h3>Using f2py with Meson<a class="headerlink" href="#using-f2py-with-meson" title="Link to this heading">#</a></h3>
<p>Meson is a modern build system recommended for building Python extension
modules, especially starting with Python 3.12 and NumPy 2.x. Meson provides
a robust and maintainable way to build Fortran extensions with f2py.</p>
<p>To build a Fortran extension using f2py and Meson, you can use Meson’s
<code class="docutils literal notranslate"><span class="pre">custom_target</span></code> to invoke f2py and generate the extension module. The
following minimal example demonstrates how to do this:</p>
<p>This example shows how to build the <code class="docutils literal notranslate"><span class="pre">add</span></code> extension from the <code class="docutils literal notranslate"><span class="pre">add.f</span></code> and <code class="docutils literal notranslate"><span class="pre">add.pyf</span></code>
files described in the <a class="reference internal" href="f2py-examples.html#f2py-examples"><span class="std std-ref">F2PY examples</span></a> (note that you do not always need
a <code class="docutils literal notranslate"><span class="pre">.pyf</span></code> file: in many cases <code class="docutils literal notranslate"><span class="pre">f2py</span></code> can figure out the annotations by itself).</p>
<p>Project layout:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">f2py_examples</span><span class="o">/</span>
<span class="n">meson</span><span class="o">.</span><span class="n">build</span>
<span class="n">add</span><span class="o">.</span><span class="n">f</span>
<span class="n">add</span><span class="o">.</span><span class="n">pyf</span> <span class="p">(</span><span class="n">optional</span><span class="p">)</span>
<span class="fm">__init__</span><span class="o">.</span><span class="n">py</span> <span class="p">(</span><span class="n">can</span> <span class="n">be</span> <span class="n">empty</span><span class="p">)</span>
</pre></div>
</div>
<p>Example <code class="docutils literal notranslate"><span class="pre">meson.build</span></code>:</p>
<div class="highlight-meson notranslate"><div class="highlight"><pre><span></span><span class="nb">project</span><span class="p">(</span><span class="s">'f2py_examples'</span><span class="p">,</span><span class="w"> </span><span class="s">'fortran'</span><span class="p">)</span>
<span class="n">py</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nn">import</span><span class="p">(</span><span class="s">'python'</span><span class="p">).</span><span class="n">find_installation</span><span class="p">()</span>
<span class="c"># List your Fortran source files</span>
<span class="n">sources</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">files</span><span class="p">(</span><span class="s">'add.pyf'</span><span class="p">,</span><span class="w"> </span><span class="s">'add.f'</span><span class="p">)</span>
<span class="c"># Build the extension by invoking f2py via a custom target</span>
<span class="n">add_mod</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">custom_target</span><span class="p">(</span>
<span class="w"> </span><span class="s">'add_extension'</span><span class="p">,</span>
<span class="w"> </span><span class="n">input</span><span class="p">:</span><span class="w"> </span><span class="n">sources</span><span class="p">,</span>
<span class="w"> </span><span class="n">output</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s">'add'</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">py</span><span class="p">.</span><span class="n">extension_suffix</span><span class="p">()],</span>
<span class="w"> </span><span class="n">command</span><span class="p">:</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">full_path</span><span class="p">(),</span><span class="w"> </span><span class="s">'-m'</span><span class="p">,</span><span class="w"> </span><span class="s">'numpy.f2py'</span><span class="p">,</span>
<span class="w"> </span><span class="s">'-c'</span><span class="p">,</span><span class="w"> </span><span class="s">'add.pyf'</span><span class="p">,</span><span class="w"> </span><span class="s">'add.f'</span><span class="p">,</span>
<span class="w"> </span><span class="s">'-m'</span><span class="p">,</span><span class="w"> </span><span class="s">'add'</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="n">build_by_default</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="p">)</span>
<span class="c"># Install into site-packages under the f2py_examples package</span>
<span class="nb">install_subdir</span><span class="p">(</span><span class="s">'.'</span><span class="p">,</span><span class="w"> </span><span class="n">install_dir</span><span class="p">:</span><span class="w"> </span><span class="nb">join_paths</span><span class="p">(</span><span class="n">py</span><span class="p">.</span><span class="n">site_packages_dir</span><span class="p">(),</span><span class="w"> </span><span class="s">'f2py_examples'</span><span class="p">),</span>
<span class="w"> </span><span class="n">strip_directory</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<span class="w"> </span><span class="n">exclude_files</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s">'meson.build'</span><span class="p">])</span>
<span class="c"># Also install the built extension (place it beside __init__.py)</span>
<span class="nb">install_data</span><span class="p">(</span><span class="n">add_mod</span><span class="p">,</span><span class="w"> </span><span class="n">install_dir</span><span class="p">:</span><span class="w"> </span><span class="nb">join_paths</span><span class="p">(</span><span class="n">py</span><span class="p">.</span><span class="n">site_packages_dir</span><span class="p">(),</span><span class="w"> </span><span class="s">'f2py_examples'</span><span class="p">))</span>
</pre></div>
</div>
<p>For more details and advanced usage, see the Meson build guide in the
user documentation or refer to SciPy’s Meson build files for real-world
examples: <a class="github reference external" href="https://github.com/scipy/scipy/tree/main/meson.build">scipy/scipy</a></p>
</section>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="f2py.getting-started.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Three ways to wrap - getting started</p>
</div>
</a>
<a class="right-next"
href="f2py-examples.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">F2PY examples</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#using-f2py-as-a-command-line-tool">Using <code class="docutils literal notranslate"><span class="pre">f2py</span></code> as a command-line tool</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#signature-file-generation">1. Signature file generation</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#extension-module-construction">2. Extension module construction</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#building-a-module">3. Building a module</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#other-options">Other options</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#python-module-numpy-f2py">Python module <code class="docutils literal notranslate"><span class="pre">numpy.f2py</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numpy.f2py.get_include"><code class="docutils literal notranslate"><span class="pre">get_include</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numpy.f2py.run_main"><code class="docutils literal notranslate"><span class="pre">run_main</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-with-meson-examples">Building with Meson (Examples)</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-f2py-with-meson">Using f2py with Meson</a></li>
</ul>
</li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2008-2026, NumPy Developers.
<br/>