Deephaven Python Ticking Package
The pydeephaven-ticking package enables access to ticking Deephaven data from Python. It extends
the functionality of the pydeephaven package to add the ability to subscribe to tables and receive
change notifications containing added, removed, and modified data. It uses Cython to create a thin
wrapper around Deephaven's C++ library.
Prerequisites
Before installing this library, you will need to install the Deephaven Core C++ library and the
pydeephaven python package. All three packages (Deephaven Core C++, pydeephaven,
and pydeephaven-ticking) are present in the Deephaven Core GitHub repository. We assume you
have checked out this repository at the location specified by ${DHROOT}.
The Deephaven C++ client (and ticking Python client) are tested regularly on Ubuntu 22.04 x86_64. Additionally, successful tests have been run on RHEL 8 and Fedora 38 (both on x86_64).
To build on Windows, please see the file cpp-client/README-windows.md in this repository.
Installation
pydeephaven-ticking can be installed with pip or by building from source.
pip
A Linux operating system on x86_64 architecture is required to install via pip.
It's recommended to install this way in a Python virtual environment (venv).
pip install pydeephaven-ticking
Build from source
If building from source, pydeephaven-ticking also requires a working installation of the C++
client. All four packages (Deephaven Core, pydeephaven, pydeephaven-ticking, and the Deephaven
C++ client) are present in the deephaven-core
repository. It is assumed that you have the repository checked out at the location specified by
${DHROOT}.
Install the C++ client
First, install the Deephaven C++ client. Follow the instructions in $DHROOT/cpp-client/README.md.
Note the restrictions on supported platforms mentioned there. The instructions will ask you to
select a location for the installation of the C++ client library and its dependencies.
According to the C++ build instructions,
the location is specified in the ${DHCPP} environment variable.
Install pydeephaven
To install pydeephaven, follow the instructions in ${DHROOT}/py/client/README.md.
These instructions will require you to create a Python venv. After installing that package, you will continue to use that venv here.
Build the ticking Python client
Install Cython in the venv
If you've exited your venv, re-activate it.
# This assumes your venv is in $HOME/py/cython
source ~/py/cython/bin/activate
Then run
pip3 install cython
Build the shared library (Linux version)
cd ${DHROOT}/py/client-ticking
# Ensure the DHCPP environment variable is set per the instructions above
rm -rf build dist src/pydeephaven_ticking/_core.cpp # Ensure we clean the remnants of any pre-existing build.
DEEPHAVEN_VERSION=$(../../gradlew :printVersion -q) CPPFLAGS="-I${DHCPP}/include" LDFLAGS="-L${DHCPP}/lib" python3 setup.py build_ext -i
Install pydeephaven-ticking
Build the wheel with
DEEPHAVEN_VERSION=$(../../gradlew :printVersion -q) python3 setup.py bdist_wheel
Then install the package.
Note: the actual name of the .whl file may be different depending on system details.
pip3 install --force --no-deps dist/pydeephaven_ticking-<x.y>-cp310-cp310-linux_x86_64.whl
The --force flag is required to overwrite any previously-built version of the package that might
already be there. The --no-deps flag ensures that we are sure to refer to the pydeephaven
package just built from the above steps, rather than one from PyPi.
Testing the library
Run tests
$ python3 -m unittest discover tests
Sample Python program
Run python from the venv while in this directory, and try this sample Python program:
import pydeephaven as dh
import time
session = dh.Session() # assuming Deephaven Community Core is running locally with the default configuration
table = session.time_table(period=1000000000).update(formulas=["Col1 = i"])
listener_handle = dh.listen(table, lambda update : print(update.added()))
listener_handle.start()
# data starts printing asynchronously here
time.sleep(10)
listener_handle.stop()
session.close()
Release files for pydeephaven-ticking 41.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| pydeephaven_ticking-41.9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl | CPython 3.13 | CPython 3.13 | Linux glibc 2.17+ x86-64 | Details |
| pydeephaven_ticking-41.9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.17+ x86-64 | Details |
| pydeephaven_ticking-41.9-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl | CPython 3.11 | CPython 3.11 | Linux glibc 2.17+ x86-64 | Details |
| pydeephaven_ticking-41.9-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl | CPython 3.10 | CPython 3.10 | Linux glibc 2.17+ x86-64 | Details |
| pydeephaven_ticking-41.9-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl | CPython 3.9 | CPython 3.9 | Linux glibc 2.17+ x86-64 | Details |
Total release size: 68.9 MB
Release files / pydeephaven_ticking-41.9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pydeephaven_ticking-41.9-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 13.8 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
dfd21b484f1132e22427f6d9007553e89e40496a59656d7ae9b4ff34ac14677a
|
|
BLAKE2b-256 checksum How to use checksums |
f86ad87cb6c10da7c185e4f4aac08de64314b9d96714c38f8144c8a33a6766a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / pydeephaven_ticking-41.9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pydeephaven_ticking-41.9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 13.8 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
5ae1de65d6023090cbff5e8584513d9b129bfc2b520cf93e06456a67446ac4cf
|
|
BLAKE2b-256 checksum How to use checksums |
e6f39e92cd5e4e73ea23e8e46548db6f44bd4314513bcb07299034d1a262e398
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / pydeephaven_ticking-41.9-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pydeephaven_ticking-41.9-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 13.8 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
8549721ed753316ce701b9aeac814064c056d8e23a007af33d24ab826d7e582e
|
|
BLAKE2b-256 checksum How to use checksums |
c04a86dc8b5c87cf427cfa79f23dfe4c48f667e69c30269029b17366134228ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / pydeephaven_ticking-41.9-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pydeephaven_ticking-41.9-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 13.8 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
555f769624156cef87a6963a32fafee005538a6120bcb7dcc4700382004ab329
|
|
BLAKE2b-256 checksum How to use checksums |
58d00f7802cfed1c5fa70e678b9b41959903c46ff6defed71b4b98598991fd5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / pydeephaven_ticking-41.9-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pydeephaven_ticking-41.9-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 13.8 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
6cc573094657ff70d3031a67161183d03fcf5968ce95dcfb234892e526928821
|
|
BLAKE2b-256 checksum How to use checksums |
1094e6be3c995a3d4edb2b462125868a566d89d508867074a91379fc3fa384f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency log