Add bitinfo codec

.github/workflows/ci-osx.yaml

@@ -0,0 +1,75 @@
+name: OSX CI
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Set up Conda
+        uses: conda-incubator/[email protected]
+        with:
+            channels: conda-forge
+            miniforge-version: latest
+            python-version: ${{ matrix.python-version }}
+
+      - name: Show info about `base` environment
+        shell: "bash -l {0}"
+        run: |
+          conda info
+          conda config --show-sources
+          conda list --show-channel-urls
+
+      - name: Set up `env`
+        shell: "bash -l {0}"
+        run: >
+          conda create -n env
+          c-compiler cxx-compiler 'clang>=12.0.1'
+          python=${{matrix.python-version}} wheel pip
+
+      - name: Show info about `env` environment
+        shell: "bash -l {0}"
+        run: |
+          conda list --show-channel-urls -n env
+
+      - name: Install numcodecs
+        shell: "bash -l {0}"
+        run: |
+          conda activate env
+          export DISABLE_NUMCODECS_AVX2=""
+          python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
+
+      - name: List installed packages
+        shell: "bash -l {0}"
+        run: |
+          conda activate env
+          python -m pip list
+
+      - name: Run tests
+        shell: "bash -l {0}"
+        run: |
+          conda activate env
+          pytest -v
+
+      - uses: codecov/codecov-action@v3
+        with:
+          #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+          #files: ./coverage1.xml,./coverage2.xml # optional
+          #flags: unittests # optional
+          #name: codecov-umbrella # optional
+          #fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)

.github/workflows/ci-windows.yaml

@@ -0,0 +1,67 @@
+name: Windows CI
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Set up Conda
+        uses: conda-incubator/[email protected]
+        with:
+            channels: conda-forge
+            miniforge-version: latest
+            python-version: ${{ matrix.python-version }}
+
+      - name: Set up `env`
+        shell: "bash -l {0}"
+        run: >
+          conda create -n env
+          c-compiler cxx-compiler
+          python=${{matrix.python-version}} wheel pip
+
+      - name: Show info about `env` environment
+        shell: "bash -l {0}"
+        run: |
+          conda list --show-channel-urls -n env
+
+      - name: Install numcodecs
+        shell: "bash -l {0}"
+        run: |
+          conda activate env
+          python -m pip install -v -e .[test,test_extras,msgpack,zfpy,pcodec]
+
+      - name: List installed packages
+        shell: "bash -l {0}"
+        run: |
+          conda activate env
+          python -m pip list
+
+      - name: Run tests
+        shell: "bash -l {0}"
+        run: |
+          conda activate env
+          pytest -v
+
+      - uses: codecov/codecov-action@v3
+        with:
+          #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+          #files: ./coverage1.xml,./coverage2.xml # optional
+          #flags: unittests # optional
+          #name: codecov-umbrella # optional
+          #fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)

.github/workflows/ci.yaml

@@ -85,5 +85,14 @@ jobs:
 
       - uses: codecov/codecov-action@v4
         with:
+<<<<<<< HEAD:.github/workflows/ci.yaml
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
+=======
+          #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+          #files: ./coverage1.xml,./coverage2.xml # optional
+          #flags: unittests # optional
+          #name: codecov-umbrella # optional
+          #fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)
+>>>>>>> ba38507 (Remove usage example from doctest):.github/workflows/ci-linux.yaml

docs/bitinfo.rst

@@ -0,0 +1,10 @@
+PCodec
+======
+
+.. automodule:: numcodecs.bitinfo
+
+.. autoclass:: BitInfo
+
+    .. autoattribute:: codec_id
+    .. automethod:: encode
+    .. automethod:: decode

docs/release.rst

@@ -13,7 +13,8 @@ Unreleased
 
 Enhancements
 ~~~~~~~~~~~~
-
+* Add bitinfo codec
+  By :user:`Timothy Hodson <thodson-usgs>` :pr:`503`.
 
 Fix
 ~~~

numcodecs/__init__.py

@@ -109,6 +109,9 @@
 
 register_codec(Shuffle)
 
+from numcodecs.bitinfo import BitInfo
+register_codec(BitInfo)
+
 from numcodecs.bitround import BitRound
 
 register_codec(BitRound)