py-hi-tension, hi-tension for Python
py-hi-tension is a Python module designed for basic but fast network
communication between scientific applications, backed by
hi-tension. The focus is on
transferring large unsized arrays of f64 with maximum throughput and minimum
latency. More informations to be found in hi-tension's github
page.
Installation
Run pip install hi-tension.
Usage
Using the library is quite simple:
# Connect to a server
socket = HiTensionSocket.connect("127.0.0.1:34487")
# You can make such a server though the following line:
# socket = HiTensionSocket.accept("127.0.0.1:34487")
# Send a simple text message
socket.send(b"status\n")
# Receive a simple text message
text_data = socket.read()
# Send formatted data as simple text message
id = 1
msg = f"do_something {id + 1}\n"
socket.send(msg.encode())
# Send formatted data and receive a high tension message
msg = f"fly {id}\n"
socket.send(msg.encode())
array = socket.hiread() # array is a numpy array
# Send the array back as a high tension message
socket.hisend(array)
socket.hidelimiter()
# You can send the array back
socket.hisend(array)
socket.hidelimiter()
# You may send your data in multible packets
socket.hisend(array[:10])
socket.hisend(array[10:])
socket.hidelimiter()
# This is useful for example if you are calculating your data while
# transferring it.Installation from sources
Building requirements
py-hi-tension requires Python 3.6 or greater. To build from source, you will also
need:
-
pipversion 18.0 or greater. - Rust version 1.41 or greater. https://www.rust-lang.org/tools/install
-
maturin:
pip install maturin -
numpy installed in your python environments (e.g.,
via
pip install numpy)- We recommend
numpy >= 1.16.0, though older version may work.
- We recommend
Building and installing
To build and install py-hi-tension, run:
pip install .
Which creates a wheel file in target/wheels/ and installs it. If you only need
the wheel file, run:
maturin build --release
