From: mtnolan2640@5b3e5887a309d4a2372aaf5e76b851870f15ca92 <mtnolan2640@web>
Date: Mon, 27 Jan 2020 14:13:57 +0000 (+0000)
Subject: Add better sfpy building instructions
X-Git-Tag: convert-csv-opcode-to-binary~3669
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d3dbf9db3bf05ab25ec29673b8eebd2dfbe5109c;p=libreriscv.git

Add better sfpy building instructions
---

diff --git a/HDL_workflow.mdwn b/HDL_workflow.mdwn
index acddfbfc4..398768c55 100644
--- a/HDL_workflow.mdwn
+++ b/HDL_workflow.mdwn
@@ -273,8 +273,42 @@ testing can then be carried out with "python3 setup.py test"
 
 These are a test suite dependency for the ieee754fpu library, and
 will be changed in the future to use Jacob's algorithmic numeric
-library.  In the meantime the README describing the process is here:
-<https://git.libre-riscv.org/?p=ieee754fpu.git;a=blob;f=README.md;h=d219864a341e4b656680de476e385b6a7f70fb9b;hb=HEAD>
+library.  In the meantime, sfpy can be built as follows:
+
+    git clone --recursive https://github.com/billzorn/sfpy.git
+    cd sfpy
+    cd SoftPosit
+    git apply ../softposit_sfpy_build.patch
+    git apply /path/to/ieee754fpu/SoftPosit.patch
+    cd ../berkely-softfloat-3
+    # Note: Do not apply the patch included in sfpy for berkely-softfloat, 
+    # it contains the same changes as this one
+    git apply /path/to/ieee754fpu/berkeley-softfloat.patch
+    cd ..
+
+    # install dependencies    
+    python -m venv .env
+    . .env/bin/activate
+    pip install --upgrade -r requirements.txt
+
+    # build
+    make lib -j8
+    make cython
+    make inplace -j8
+    make wheel
+
+    # install
+    deactivate # deactivates venv, optional 
+    pip install dist/sfpy*.whl
+
+You can test your installation by doing the following:
+
+    python
+    >>> from sfpy import *
+    >>> Posit8(1.3)
+
+It should print out `Posit8(1.3125)`
+  
 
 # Registering for git repository access