Rename to cryptomite!

Author: y-richie-y

.github/workflows/build_test.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
 
 env:
-  SRC_DIR: extlib
+  SRC_DIR: cryptomite
 
 jobs:
   lint:

.github/workflows/linuxbuildwheels

@@ -2,15 +2,15 @@
 
 set -evu
 
-cd /extlib
+cd /cryptomite
 mkdir wheelhouse
 mkdir audited
 
 for pyX in $PY_VERS
 do
-    cd /extlib
+    cd /cryptomite
     export PYEX=/opt/python/${pyX}/bin/python
     ${PYEX} -m pip install -U pip wheel scikit-build
     ${PYEX} setup.py bdist_wheel -d "tmpwheel_${pyX}"
-    auditwheel repair "tmpwheel_${pyX}/extlib-"*".whl" -w "audited/"
+    auditwheel repair "tmpwheel_${pyX}/cryptomite-"*".whl" -w "audited/"
 done

.github/workflows/macosbuildwheel

@@ -7,4 +7,4 @@ cd ${GITHUB_WORKSPACE}
 PYVER=`python -c 'import sys; print(".".join(map(str, sys.version_info[:3])))'`
 python -m pip install -U pip wheel scikit-build delocate
 python setup.py bdist_wheel -d "${GITHUB_WORKSPACE}/tmpwheel_${PYVER}"
-delocate-wheel -v -w "${GITHUB_WORKSPACE}/wheelhouse/" "${GITHUB_WORKSPACE}/tmpwheel_${PYVER}/extlib-"*".whl"
+delocate-wheel -v -w "${GITHUB_WORKSPACE}/wheelhouse/" "${GITHUB_WORKSPACE}/tmpwheel_${PYVER}/cryptomite-"*".whl"

.github/workflows/wheels.yml

@@ -14,13 +14,13 @@ jobs:
     - name: set up container
       run: |
         docker create --name linux_build -i -v /:/host quay.io/pypa/manylinux2014_x86_64:latest /bin/bash
-        docker cp . linux_build:/extlib/
+        docker cp . linux_build:/cryptomite/
     - name: run build
       run: |
         docker start linux_build
-        docker exec -e PY_VERS="${PY_VERS}" linux_build /bin/bash -c "/extlib/.github/workflows/linuxbuildwheels"
+        docker exec -e PY_VERS="${PY_VERS}" linux_build /bin/bash -c "/cryptomite/.github/workflows/linuxbuildwheels"
         mkdir wheelhouse
-        docker cp linux_build:/extlib/audited/. wheelhouse/
+        docker cp linux_build:/cryptomite/audited/. wheelhouse/
     - uses: actions/upload-artifact@v2
       with:
         name: linux_wheels

.gitignore

@@ -1,5 +1,5 @@
-# `extlib/version.py` is generated automatically by setuptools-scm
-extlib/version.py
+# `cryptomite/version.py` is generated automatically by setuptools-scm
+cryptomite/version.py
 
 # development files
 *.egg-info/
@@ -17,5 +17,5 @@ docs/_*
 # ignore scikit-build stuff
 _skbuild/
 */*.so
-extlib/lib
-extlib/include
+cryptomite/lib
+cryptomite/include

CMakeLists.txt

@@ -1,9 +1,9 @@
 cmake_minimum_required(VERSION 3.22.1)
 
-project(extlib)
+project(cryptomite)
 
 set(CMAKE_CXX_STANDARD 20)
 
 add_subdirectory(src)
 
-add_subdirectory(extlib)
+add_subdirectory(cryptomite)

README.md

@@ -1,12 +1,12 @@
-# Extlib
+# cryptomite
 
 An awesome random extraction library. Work in progress.
 
 
 ## Example Usage
 
 ```python
-from extlib.trevisan import Trevisan
+from cryptomite.trevisan import Trevisan
 from random import randint
 
 n, m, max_eps = 1000, 200, 0.01

extlib/CMakeLists.txt renamed to cryptomite/CMakeLists.txt

@@ -7,10 +7,10 @@ FetchContent_Declare(
   URL_HASH SHA256=c6160321dc98e6e1184cc791fbeadd2907bb4a0ce0e447f2ea4ff8ab56550913
 )
 FetchContent_MakeAvailable(pybind11)
-pybind11_add_module(_extlib MODULE pyextlib.cpp)
+pybind11_add_module(_cryptomite MODULE pycryptomite.cpp)
 
-target_link_libraries(_extlib PUBLIC trevisan)
+target_link_libraries(_cryptomite PUBLIC trevisan)
 
-install(TARGETS _extlib DESTINATION .)
+install(TARGETS _cryptomite DESTINATION .)
 
 set(ignoreMe "${SKBUILD}")

cryptomite/__init__.py

@@ -0,0 +1,4 @@
+
+__all__ = ['dodis', 'toeplitz', 'trevisan']
+
+from cryptomite import dodis, toeplitz, trevisan

extlib/dodis.py renamed to cryptomite/dodis.py

@@ -7,7 +7,7 @@
 from math import floor, log2
 from typing import cast
 
-from extlib.utils import BitsT, conv, log_2, na_set
+from cryptomite.utils import BitsT, conv, log_2, na_set
 
 __all__ = ['Dodis']
 

extlib/pyextlib.cpp renamed to cryptomite/pycryptomite.cpp

@@ -8,7 +8,7 @@ namespace py = pybind11;
 
 // PYBIND11_MAKE_OPAQUE(std::vector<int>);
 
-PYBIND11_MODULE(_extlib, m) {
+PYBIND11_MODULE(_cryptomite, m) {
     // optional module docstring
     m.doc() = "C++ Implementation of Randomness Extractors";
 

extlib/toeplitz.py renamed to cryptomite/toeplitz.py

@@ -6,7 +6,7 @@
 
 from typing import cast
 
-from extlib.utils import BitT, BitsT, conv, log_2
+from cryptomite.utils import BitT, BitsT, conv, log_2
 
 __all__ = ['Toeplitz']
 

extlib/trevisan.py renamed to cryptomite/trevisan.py

@@ -5,7 +5,7 @@
 
 __all__ = ['Trevisan']
 
-from extlib import _extlib
+from cryptomite import _cryptomite
 
 
 class Trevisan:
@@ -29,8 +29,8 @@ def __init__(self, n: int, k: float, max_eps: float):
             max_eps : float
                 The total worst case error.
         """
-        self.config = _extlib.TrevisanConfig(n, k, max_eps)
-        self.ext = _extlib.Trevisan(self.config)
+        self.config = _cryptomite.TrevisanConfig(n, k, max_eps)
+        self.ext = _cryptomite.Trevisan(self.config)
 
     def extract(self, source: list[bool], seed: list[bool]) -> list[bool]:
         """

extlib/utils.py renamed to cryptomite/utils.py

@@ -6,7 +6,7 @@
 from math import sqrt
 from typing import Literal, Sequence
 
-from extlib._extlib import NTT, mul_vec
+from cryptomite._cryptomite import NTT, mul_vec
 
 __all__ = ['is_prime', 'prime_facto', 'na_set', 'von_neumann']
 

docs/conf.py

@@ -20,7 +20,7 @@
 release = version = "[put version here]"
 
 
-project = 'extlib'
+project = 'cryptomite'
 copyright = '2021, 2022, Cambridge Quantum Computing Ltd.'
 author = 'Cambridge Quantum Team'
 

docs/extlib.rst renamed to docs/cryptomite.rst

@@ -1,45 +1,45 @@
-extlib package
+cryptomite package
 ==============
 
 Submodules
 ----------
 
-extlib.dodis module
+cryptomite.dodis module
 -------------------
 
-.. automodule:: extlib.dodis
+.. automodule:: cryptomite.dodis
    :members:
    :undoc-members:
    :show-inheritance:
 
-extlib.toeplitz module
+cryptomite.toeplitz module
 ----------------------
 
-.. automodule:: extlib.toeplitz
+.. automodule:: cryptomite.toeplitz
    :members:
    :undoc-members:
    :show-inheritance:
 
-extlib.trevisan module
+cryptomite.trevisan module
 ----------------------
 
-.. automodule:: extlib.trevisan
+.. automodule:: cryptomite.trevisan
    :members:
    :undoc-members:
    :show-inheritance:
 
-extlib.utils module
+cryptomite.utils module
 ----------------------
 
-.. automodule:: extlib.utils
+.. automodule:: cryptomite.utils
    :members:
    :undoc-members:
    :show-inheritance:
 
 Module contents
 ---------------
 
-.. automodule:: extlib
+.. automodule:: cryptomite
    :members:
    :undoc-members:
    :show-inheritance:

docs/examples/quantum-key-distribution.ipynb

@@ -27,7 +27,7 @@
    "source": [
     "## Experimental CV-QKD\n",
     "Following the experimental results of the continuous variable protocol outlined in \\cite{jain2022practical}, we give pseudocode replicating the\n",
-    "privacy amplification step of their experiment using our extractor library \\texttt{extlib}. This example can be easily adapted to any explicit QKD protocol. \n",
+    "privacy amplification step of their experiment using our extractor library \\texttt{cryptomite}. This example can be easily adapted to any explicit QKD protocol. \n",
     "In this protocol, the quantum information is encoded into the amplitude and phase quadratures of the optical field. \n",
     "Alice encodes random bits, which she generates with a quantum random number generator (QRNG), by modulating the optical signal field to obtain coherent states.\n",
     "The QRNG used to generate random bits is based on \\cite{gabriel2010generator}, which consists of homodyne measurements of the vacuum state. \n",
@@ -44,7 +44,7 @@
     "\n",
     "The experimental implementation uses the $\\Toeplitz$ extractor for privacy amplification, with a raw key input length \n",
     "of $n = 1.738 \\times 10^9$, an output of $m = 41378264$ and therefore, a required seed length of $d = 1.738 \\times 10^9 + 41378263$.\n",
-    "This privacy amplification step can be performed easily using our randomness extractor library \\texttt{extlib} as follows in Fig. \\ref{fig:pa}. \n"
+    "This privacy amplification step can be performed easily using our randomness extractor library \\texttt{cryptomite} as follows in Fig. \\ref{fig:pa}. \n"
    ]
   },
   {
@@ -54,7 +54,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import extlib\n",
+    "import cryptomite\n",
     "def privacy_amplification(seed_bits, raw_key_bits, n = 1.738 * 10**9, m = 41378264):\n",
     "  \"\"\" Perform privacy amplification for Practical \n",
     "  CV-QKD with composable security.\n",
@@ -79,7 +79,7 @@
     "  \"\"\"\n",
     "  assert len(seed_bits) == n + m - 1\n",
     "  assert len(raw_key_bits) == n\n",
-    "  toeplitz = extlib.Toeplitz(n, m)\n",
+    "  toeplitz = cryptomite.Toeplitz(n, m)\n",
     "  return toeplitz.extract(seed_bits, raw_key_bits)"
    ]
   },
@@ -96,7 +96,7 @@
     "\n",
     "Since the QRNG generating the seed bits is device-dependent the quality of the seed relies on the correct characterization and perfect modelling of the device.\n",
     "This opens the possibility that the seed bits may only be somewhat random.\n",
-    "In this case, a shared secret key can still be generated, but each user must use the Toeplitz two-source (as opposed to seeded) randomness extractor extension from \\texttt{extlib} and adjust their output length accordingly. \n",
+    "In this case, a shared secret key can still be generated, but each user must use the Toeplitz two-source (as opposed to seeded) randomness extractor extension from \\texttt{cryptomite} and adjust their output length accordingly. \n",
     "Below we show an example of this when considering the QRNG generated seed bits have a min-entropy rate of 0.99 (as opposed to 1 if it had been perfectly random). \n",
     "Let $\\boldsymbol{x}, \\boldsymbol{y}$ be the raw key bits and seed bits respectively, then the output length is adjusted to $m' = \\frac{1}{3} (41378264 - 2 (k_1 - n) + 2)$, where $k_1 = 0.99 \\times n$ is the seed min-entropy.\n",
     "\n",
@@ -108,7 +108,7 @@
     "  \\State $m \\gets 41378264$ \\Comment{original output length}\n",
     "  \\State $k_1 \\gets 0.99 \\times n$ \\Comment{calculate seed min-entropy} \n",
     "  \\State $m' \\gets \\frac{1}{3} (41378264 - 2 (k_1 - n) + 2)$ \\Comment{new output length, given by \\eqref{eq:toeplits-q-2-params}}\n",
-    "  \\State \\textbf{return} \\texttt{extlib.Toeplitz(n, m).extract($\\bm{x}, \\bm{y}$)}\n",
+    "  \\State \\textbf{return} \\texttt{cryptomite.Toeplitz(n, m).extract($\\bm{x}, \\bm{y}$)}\n",
     "  \\EndFunction\n",
     "\\end{algorithmic}\n",
     "\\end{algorithm}\n",
@@ -128,7 +128,7 @@
     "  \\State $l \\gets \\max( 1 , \\Bigl\\lceil \\frac{\\log(m-r) - \\log(t-r)}{\\log(r) - log(r-1)} \\Bigr \\rceil)$ \n",
     "  \\Comment{number of iterations of the weak design}\n",
     "  \\State $d \\gets (l+1)\\times t^2$ \\Comment{seed length}\n",
-    "  \\State \\textbf{return} \\texttt{extlib.Trevisan(n, d, m).extract($\\bm{x}, \\bm{y}$)}\n",
+    "  \\State \\textbf{return} \\texttt{cryptomite.Trevisan(n, d, m).extract($\\bm{x}, \\bm{y}$)}\n",
     "  \\EndFunction\n",
     "\\end{algorithmic}\n",
     "\\end{algorithm}"

docs/examples/quantum-random-number-generation.ipynb

@@ -32,7 +32,7 @@
     "The experimental demonstration uses the Toeplitz extractor, which can give an output length of $\\geq 581294933$, given the\n",
     "extractor error is $\\leq 10^{-10}$. \n",
     "This requires a seed of $7081294934$ bits and for the raw randomness input length of $6.5 \\cdot 10^{9}$.\n",
-    "This randomness extraction can be performed easily using our randomness extractor library \\texttt{extlib} as follows in Fig. \\ref{fig:re}. "
+    "This randomness extraction can be performed easily using our randomness extractor library \\texttt{cryptomite} as follows in Fig. \\ref{fig:re}. "
    ]
   },
   {
@@ -42,7 +42,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import extlib\n",
+    "import cryptomite\n",
     "from math import log2, floor\n",
     "def randomness_extraction(seed_bits, raw_randomness, n = 6500000000, k = 581295000, epsilon = 10**-10 ):\n",
     "  \"\"\" Perform randomness extraction for semi-DI QRNG. \n",
@@ -68,7 +68,7 @@
     "  assert len(seed_bits) == n + m - 1\n",
     "  assert len(raw_randomness) == n\n",
     "  m = floor(k + 2*log2(epsilon))\n",
-    "  toeplitz = extlib.Toeplitz(n, m)\n",
+    "  toeplitz = cryptomite.Toeplitz(n, m)\n",
     "  return toeplitz.extract(seed_bits, raw_randomness)"
    ]
   },

docs/index.rst

@@ -1,16 +1,16 @@
-extlib
+cryptomite
 ======
 
 This is a library. Stuff goes here.
 
 .. code-block:: bash
 
-   pip install extlib
+   pip install cryptomite
 
 .. toctree::
    :caption: Toolkit
    :maxdepth: 4
 
    intro
    glossary
-   extlib
+   cryptomite

docs/notebooks.rst

@@ -3,7 +3,7 @@
 Examples
 ========
 
-In this section we give some explicit examples and pseudocode using \texttt{extlib} on recent experimental quantum cryptography demonstrations.
+In this section we give some explicit examples and pseudocode using \texttt{cryptomite} on recent experimental quantum cryptography demonstrations.
 Since our package is easy to use, efficient and numerically precise, it is perfect for these applications. 
 We also highlight some extensions in these examples, whereby the results of these previous works could be improved by some combination of 
 (i) relaxing assumptions and (ii) speeding-up implementation.

extlib/__init__.py

@@ -1,5 +1,5 @@
 [metadata]
-name = extlib 
+name = cryptomite 
 description = An awesome extractor library
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -25,7 +25,7 @@ classifiers =
 
 [options]
 packages =
-    extlib
+    cryptomite
 install_requires =
 python_requires = >=3.8
 

extlib/__pycache__/__init__.cpython-39.pyc

@@ -5,6 +5,6 @@
 
 setup(
     zip_safe=False,
-    packages=["extlib"],
-    cmake_install_dir="extlib",
+    packages=["cryptomite"],
+    cmake_install_dir="cryptomite",
 )

extlib/__pycache__/dodis.cpython-39.pyc

@@ -1,5 +1,5 @@
 import pytest
-from extlib.dodis import Dodis
+from cryptomite.dodis import Dodis
 
 
 dodis_testcases = [

extlib/__pycache__/hayashi.cpython-39.pyc

@@ -1,5 +1,5 @@
 import pytest
-from extlib.toeplitz import Toeplitz
+from cryptomite.toeplitz import Toeplitz
 
 
 toeplitz_testcases = [