Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add f2py section to porting guide #50

Merged
merged 3 commits into from
Jul 25, 2024
Merged

Add f2py section to porting guide #50

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61adb17
Add f2py section to porting guide
ngoldbaum Jul 24, 2024
31e1063
remove discussion of threadsafe keyword
ngoldbaum Jul 24, 2024
be24042
respond to Ralf's comments
ngoldbaum Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/porting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,21 @@ after importing a module that does not support the GIL.
endif
```

=== "f2py"

Starting with NumPy 2.1.0 (only available via the nightly wheels or the
`main` branch as of right now), Fortran extension modules wrapped using
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Fortran extension modules" wording looks very slightly off to me, but I'm also having a hard time rewording it. Perhaps "extension modules containing f2py-wrapped Fortran code" works?

f2py can declare they are thread safe and support free-threading using the
[`--freethreading-compatible`](https://numpy.org/devdocs/f2py/usage.html#extension-module-construction)
command-line argument:

```bash
$ python -m numpy.f2py -c code.f -m my_module --freethreading-compatible
```

If you know the extension is *not* thread safe, then you can force the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be necessary right, since that's the default already? If so, then it's better to leave this out I think.

Or do you recommend this for clarity only? If so, I suggest saying that explicitly.

extension to require the GIL with `--no-freethreading-compatible.


If you publish binaries and have downstream libraries that depend on your
library, we suggest adding support as described above and uploading nightly wheels
Expand Down