-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b8c8918
commit 25e3043
Showing
4 changed files
with
115 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# blosc2_grok | ||
|
||
For using blosc2_grok you will first have to create and install its wheel. | ||
|
||
## Create the wheel | ||
|
||
For Linux: | ||
|
||
```shell | ||
python -m cibuildwheel --only 'cp311-manylinux_x86_64' | ||
``` | ||
|
||
For Mac x86_64: | ||
|
||
```shell | ||
CMAKE_OSX_ARCHITECTURES=x86_64 python -m cibuildwheel --only 'cp311-macosx_x86_64' | ||
``` | ||
|
||
For Mac arm64: | ||
|
||
```shell | ||
CMAKE_OSX_ARCHITECTURES=arm64 python -m cibuildwheel --only 'cp311-macosx_arm64' | ||
``` | ||
|
||
## Install the wheel | ||
|
||
```shell | ||
pip install wheelhouse/blosc2_grok-*.whl --force-reinstall | ||
``` | ||
|
||
That's all folks! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
Releasing a version | ||
=================== | ||
|
||
Preliminaries | ||
------------- | ||
|
||
- Make sure that ``RELEASE_NOTES.md`` and ``ANNOUNCE.md`` are up to | ||
date with the latest news in the release. | ||
|
||
- Check that *VERSION* symbols in blosc2_grok/__init__.py | ||
*and* pyproject.toml contain the correct info. | ||
|
||
- Commit the changes with:: | ||
|
||
$ git commit -a -m "Getting ready for release X.Y.Z" | ||
$ git push | ||
|
||
|
||
Testing | ||
------- | ||
|
||
Follow the steps in README-DEVELOPERS.md file for locally creating and | ||
installing the wheel, then test it:: | ||
|
||
$ cd examples | ||
$ python roundtrip.py MI04_020751.tif | ||
|
||
|
||
Tagging | ||
------- | ||
|
||
- Create a tag ``X.Y.Z`` from ``main``. Use the next message:: | ||
|
||
$ git tag -a vX.Y.Z -m "Tagging version X.Y.Z" | ||
|
||
- Push the tag to the github repo:: | ||
|
||
$ git push --tags | ||
|
||
- Create a new release visiting https://github.com/Blosc/blosc2_btune/releases/new | ||
and add the release notes copying them from `RELEASE_NOTES.md` document. | ||
|
||
|
||
Check documentation | ||
------------------- | ||
|
||
Check that the `README.md` and `README-DEVELOPERS.md` are consistent with this new release. | ||
|
||
|
||
Announcing | ||
---------- | ||
|
||
- Send an announcement to the blosc and comp.compression mailing lists. | ||
Use the ``ANNOUNCE.md`` file as skeleton (likely as the definitive version). | ||
|
||
- Tweet/toot about it from the @Blosc2 account. | ||
|
||
|
||
Post-release actions | ||
-------------------- | ||
|
||
- Edit *VERSION* symbols in blosc2_btune/__init__.py *and* src/btune.h *and* pyproject.toml in main to increment the | ||
version to the next minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev). | ||
|
||
- Create new headers for adding new features in ``RELEASE_NOTES.md`` | ||
and add this place-holder instead: | ||
|
||
#XXX version-specific blurb XXX# | ||
|
||
- Commit the changes:: | ||
|
||
$ git commit -a -m"Post X.Y.Z release actions done" | ||
$ git push | ||
|
||
That's all folks! | ||
|
||
|
||
.. Local Variables: | ||
.. mode: rst | ||
.. coding: utf-8 | ||
.. fill-column: 70 | ||
.. End: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,7 +13,7 @@ build-backend = "scikit_build_core.build" | |
|
||
[project] | ||
name = "blosc2_grok" | ||
version = "0.0.1.dev" | ||
version = "0.0.1" | ||
readme = "README.md" | ||
authors = [ | ||
{name = "Blosc Development Team", email = "[email protected]"}, | ||
|