readme_distributors.rst
1****************************
2Information for Distributors
3****************************
4
5The information given here is intended for people distributing pygsl as
6well as for people who are not afraid to run code generation tools in
7case pygsl generates trouble.
8
9Preferable array module
10-----------------------
11
12The only array module supported is numpy.
13
14Wrapper generated modules
15-------------------------
16
17The following modules are generated by the SWIG wrappers:
18
19* _block
20* _callback
21* gslwrap
22* hankel
23* _poly
24
25In case on of these modules shows a compilation error, just delete the
26corresponding file in the swig\_src directory (e.g.
27swig\_src/poly\_wrap.c if for the poly module.). Set the variable
28``USE_SWIG`` to ``1`` in the ``setup.py`` file. Run the build process
29again. Now setup.py should call swig and rebuild the module wrappers.
30
31Dedicated wrappers
32------------------
33
34Some modules come with their own wrapping tools which are implemented in
35python.
36
37The const module
38~~~~~~~~~~~~~~~~
39
40Change into the src directory. Define the shell variable
41``PYGSL_GSLCVS`` variable, so that it either points to the GSL CVS
42repository or to the include directory of your GSL installation
43(typically /usr/include on a linux installation). Then type
44``python ../tools/constants_tool.py`` This will generate the files
45``const_m_array.c``, ``const_num_array.c``, ``const_cgsm_array.c``
46and ``const_mksa_array.c``.
47
48The special function module
49~~~~~~~~~~~~~~~~~~~~~~~~~~~
50
51PyGSL comes with one implementations for the special functions, which
52is currently found intesting.sf module.
53
54
55Generating the wrapper has not been automatized yet. First swig is used
56to parse the header files and dump them into xml and then a specialized
57wrapper reads this tree and writes the wrappers.
58
59First generate the wrapper by executing in the shell
60
61.. code-block:: bash
62
63 python setup.py gsl_wrappers
64
65Then run the build process. Set ``BUILD_TESTING = 1`` in the setup.py
66file. If required update the time stamp of the file
67``testing/src/sf/sfmodule_testing.c``. This will build the module
68``_ufuncs``.
69
70The functions not wrapped automatically are defined in the file
71``sf.i``
72