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

Update README.md #6

Merged
merged 2 commits into from
Jan 25, 2025
Merged

Update README.md #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59810e3
Update README.md
tlambert03 Jan 25, 2025
f555d0a
fix typo
tlambert03 Jan 25, 2025
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,15 @@ print(vec_float)
## How?

`witty` invokes `cython` to compile the module given as a PYX string (just like it would compile it during build time). The compiled module ends up in the Cython cache directory, with a hash build from the content of the PYX string. Repeated calls to `compile_module` will only invoke the compiler if the exact PYX string has not been compiled before (or if `force_rebuild==True`). Compilation is protected by a file lock, i.e., concurrent calls to `compile_module` are safe.

## For developers

To push a new release, make sure you've pulled main and are definitely on
the commit you want to release, then tag a commit and push to github:

```sh
git tag -a vX.Y.Z -m vX.Y.Z
git push upstream --follow-tags
```

The deploy is handled by [`workflows/ci.yaml`](.github/workflows/ci.yaml#L44)
Loading