X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=README.md;h=df4708e46f2e433aeae787be212df9a9626ed1de;hb=baa24b1330359524e10f6d7b626f99795fc07018;hp=d1814cf217b63302c589dcb4e047a6db1b8397bd;hpb=03cecad0b5793eb349e5d9f07524583df5ba09b6;p=sfpy.git diff --git a/README.md b/README.md index d1814cf..df4708e 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,12 @@ # sfpy softfloat and softposit in Python + * support for softfloat float16, float32, and float64 * support for softposit posit8, quire8, posit16, and quire16 - * no softfloat support yet, still WIP - + ## Demo ``` ->>> from sfpy import Posit16, Quire16 ->>> Posit16(1.3) + Posit16(1.4) -Posit16(2.7001953125) ->>> x = Posit16(7) ->>> x -Posit16(1.7881393432617188e-07) ->>> x += Posit16(9) ->>> x -Posit16(4.76837158203125e-07) ->>> q = Quire16() ->>> q.fdp_add(Posit16(11.0), Posit16(2.0)) ->>> q -uA.ui : 29056 -Quire16(22.0) ->>> q.p16 -uA.ui : 29056 -Posit16(22.0) +# WIP ``` -For a basic performance test of the API, try: `python timing.py` - ## Building -The cython module can be built in place in the usual way: -`python setup.py build_ext --inplace` -This requires the submodules to be checked out, and the static library `SoftPosit/build/Linux-x86_64-GCC/softposit.a` to be built. Note that in order for cython to be able to build the shared object for the module, the static library must be compiled with -fPIC, which currently requires modifying the appropriate Makefile manually. - -The package can also be installed to a local Python distribution with pip, i.e. `pip install .` using the appropriate pip. +See [BUILDING](BUILDING.md). \ No newline at end of file