Update READMEs, NOTICE, and docs for ctypesgen

benbarsdell · benbarsdell · commit 4d9c3dc77a6d · 2017-07-30T18:59:36.000-07:00
diff --git a/NOTICE b/NOTICE
@@ -6,6 +6,3 @@ This product includes software developed at NVIDIA Corporation.
 
 Bifrost includes source code from the int_fastdiv library (Copyright
 2014 Maxim Milakov) licensed under the Apache License Version 2.0.
-
-Bifrost uses the PyCLibrary library (Copyright 2010 Luke Campagnola,
-2015 Matthieu Dartiailh) licensed under the MIT License.
diff --git a/README.md b/README.md
@@ -83,23 +83,22 @@ Install dependencies:
 
 Install dependencies:
 
- * [PyCLibrary fork](https://github.com/MatthieuDartiailh/pyclibrary)
- * Numpy
+ * numpy
  * matplotlib
  * contextlib2
  * pint
- 
+ * ctypesgen
 
 ```
-$ sudo pip install numpy matplotlib contextlib2 pint git+https://github.com/MatthieuDartiailh/pyclibrary.git@dff70337fd904a43de2bdd05dc548620160354d0
+$ sudo pip install numpy matplotlib contextlib2 pint git+https://github.com/davidjamesca/ctypesgen.git@3d2d9803339503d2988382aa861b47a6a4872c32
 ```
 
 ### Bifrost installation
 
 Edit **user.mk** to suit your system, then run:
 
     $ make -j
-    $ sudo make install 
+    $ sudo make install
 
 which will install the library and headers into /usr/local/lib and
 /usr/local/include respectively.
@@ -108,12 +107,6 @@ You can call the following for a local Python installation:
 
     $ sudo make install PYINSTALLFLAGS="--prefix=$HOME/usr/local"
 
-Note that the bifrost module's use of PyCLibrary means it must have
-access to both the bifrost shared library and the bifrost headers at
-import time. The LD_LIBRARY_PATH and BIFROST_INCLUDE_PATH environment
-variables can be used to add search paths for these dependencies
-respectively.
-
 ### Docker container
 
 Install dependencies:
@@ -157,7 +150,7 @@ Doxygen documentation can be generated by running:
     $ make doc
 
 This documentation can then be used in a Sphinx build
-by running 
+by running
 
     $ make html
 
diff --git a/docs/source/Common-installation-and-execution-problems.rst b/docs/source/Common-installation-and-execution-problems.rst
@@ -12,16 +12,6 @@ timeout, and some blocks are not ending themselves. Quit the program (by
 ctrl-\\), and make sure every block in your pipeline is reading/writing
 to its rings as it should.
 
-ImportError: No module named pyclibrary
----------------------------------------
-
-You have not installed PyCLibrary, or you are using two different python
-installations (e.g., one installed via apt-get, and one installed from
-source in a local directory, or one in a virtual environment). Make sure
-you are using the same Python to install libraries as you are to run
-programs. Get PyCLibrary from
-`here <https://github.com/MatthieuDartiailh/pyclibrary>`__.
-
 OSError: ..../lib/libbifrost.so: undefined symbol: cudaFreeHost
 ---------------------------------------------------------------
 
@@ -33,9 +23,9 @@ still having trouble, raise an issue.
 OSError: Can't find library with name libbifrost.so
 ---------------------------------------------------
 
-This means that PyCLibrary can't find your Bifrost installation.
-Whatever library folders it searches for Bifrost, you do not have the
-libbifrost.so file there. To fix this, type
+This means that the bifrost Python wrapper can't find your Bifrost
+installation. Whatever library folders it searches for Bifrost, you
+do not have the libbifrost.so file there. To fix this, type
 
 ``echo $LD_LIBRARY_PATH``
 
@@ -47,7 +37,7 @@ problem. Perform
 
 where ``/my/bifrost/installation`` is the folder where you installed the
 Bifrost "lib" (in config.mk, this folder is given as
-``INSTALL_LIB_DIR``). This should add Bifrost to the PyCLibrary search
+``INSTALL_LIB_DIR``). This should add Bifrost to the wrapper's search
 path.
 
 OSError: libcudart.so.x.0: cannot open shared object file: No such file or directory
diff --git a/docs/source/Getting-started-guide.rst b/docs/source/Getting-started-guide.rst
@@ -37,29 +37,11 @@ as follows:
 3. Check pip is working with ``pip list``, which will give the versions
    of pip and setuptools.
 
-numpy, matplotlib, contextlib2, simplejson, pint, graphviz
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+numpy, matplotlib, contextlib2, simplejson, pint, graphviz, ctypesgen
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If you have already installed pip, this step should be as simple as
-``pip install --user numpy matplotlib contextlib2 simplejson pint graphviz``.
-
-`PyCLibrary (modified) <https://github.com/MatthieuDartiailh/pyclibrary>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-PyCLibrary is a Python library that will parse C files and ease the
-interaction with ``ctypes``. The entire Bifrost front end is built with
-it. **Do not install the pip version, as it is out of date**. You need
-to get the source from
-`GitHub <https://github.com/MatthieuDartiailh/pyclibrary>`__, and
-install it manually:
-
-1. Download PyCLibrary by running
-   ``git clone https://github.com/MatthieuDartiailh/pyclibrary``
-2. Enter the PyCLibrary folder that was just created, and run
-   ``python setup.py install --user``.
-3. Check that PyCLibrary installed correctly by running ``python``, and
-   then trying ``import pyclibrary``. If this works, you are ready to
-   go.
+``pip install --user numpy matplotlib contextlib2 simplejson pint graphviz git+https://github.com/davidjamesca/ctypesgen.git@3d2d9803339503d2988382aa861b47a6a4872c32``.
 
 C++ dependencies
 ~~~~~~~~~~~~~~~~
diff --git a/docs/source/How-Python-and-C---fits-together.rst b/docs/source/How-Python-and-C---fits-together.rst
@@ -107,7 +107,7 @@ Once this is recompiled, open up iPython and try this:
     print a
 
 That is: your ``AddStuff`` function is available in python via some
-`pyclibrary <http://pyclibrary.readthedocs.io/en/latest/>`__ magic. You
+`ctypesgen <https://github.com/davidjamesca/ctypesgen>`__ magic. You
 can't just pass ``a`` and ``b`` by themselves, but you can send their
 ``as_BFarray()`` output.
 
diff --git a/test/benchmarks/README.rst b/test/benchmarks/README.rst
@@ -43,7 +43,7 @@ Here is a list of all current and future benchmark tests for Bifrost.
     #. Backend
         1. General ring operations
         #. General sequence operations
-        #. Latency of PyCLibrary calls
+        #. Latency of Python-wrapped calls
     #. :code:`compile_time.sh` - Bifrost compile time
 #. :code:`performance_vs_serial/` - Performance comparisons with Serial
     1. :code:`linear_fft_pipeline.py` - Linear repeated-FFT pipeline
