How to call the NAG C library from Python using ctypes

April 1st, 2009 | Categories: NAG Library, programming, python | Tags:

The NAG library is possibly the most comprehensive numerical library available today with over 1500 functions and a long and distinguished history going back almost 40 years.  Although it is commercial, NAG is a not-for-profit company and has donated large amounts of code to the open source community over the years.  The library covers many application areas including special functions, optimization, curve fitting, statistics, numerical differentiation and linear algebra among others with even more coming up in the next release. It has been available in several different programming languages over the years but these days you can get it in essentially four flavours – The NAG Fortran Library, The NAG C Library, the Maple-NAG connector and the NAG Toolbox for MATLAB.

I have been supporting users of the NAG library at Manchester University for a few years now and one of the most common reactions I get from a potential user of the NAG libraries when they see the list of available languages is to say ‘I don’t program in any of those – I program in XYZ – so the NAG library is no use to me.’ where XYZ might be Java, Perl, Visual Basic, Python, R or one of any number of weird and wonderful possibilities.

It turns out that YOUR choice of language almost doesn’t matter as far as NAG is concerned since, with a bit of work, you can call the NAG routines from pretty much any language you care to mention. Put another way, NAG program in Fortran (and C) so you don’t have to. One language that has been mentioned a lot recently is Python.

Mat Cross, an employee of NAG, wrote a guide a little while ago giving detailed instructions on how to call the NAG Fortran library from Python using a module called F2PY and very nice it is too. However, some people are never happy and almost as soon as the article was published I started getting queries about the NAG C library and Python. As far as I could tell this particular combination hadn’t been covered by anyone before so I rolled up my sleeves to see what I could come up with.

After all, how hard could it be?

I have lost count of the number of times I have regretted uttering that particular phrase but in this case, thanks to a wonderful Python module called ctypes, the answer turns out to be ‘Not nearly as hard as you might expect’.

The results of my investigations will be posted on Walking Randomly over the next few weeks and will include several examples of how to use the NAG C library within Python. I’ll start off with the simplest of NAG functions and steadily move towards some of the most complex. On the way we will cover several areas of numerical mathematics including special functions, numerical quadrature, root finding and optimization.

I will initially be concentrating on Ubuntu Linux since that is my favourite development environment but I am aware that users of both NAG and Python make use of many platforms including Windows and Mac OS X. If there is sufficient interest then I will make other platform-specific articles available in the future.

The list below contains links to all of the articles published in the series so far and will be expanded as new ones come online so this post will eventually serve as an index to the whole series. Extra topics may be considered on request.

Topic List (will be expanded as new articles are available)

  1. Making simple NAG C functions available to Python
  2. Plotting the Cosine Integral using NAG and matplotlib
  3. Callback functions (The example code given is for finding the zero’s of an equation)
  4. Structures (The example code given is for Numerical Integration)
  5. Callback functions with communication (The example code solves a simple 1d minimization problem)
  6. PyNAG – A Python package for interfacing with the NAG C Library

Implementation specifics
The NAG C library is available for a wide range of platforms and C compilers (representing 26 different combinations when I last counted) but I only wanted to focus on one for the sake of sanity! In particular, I am using cllux08dgl throughout this series which is for 32bit Linux and was compiled using the gcc compiler.  I am using version 8.10 of Ubuntu Linux.

I imagine that most of what I write will be directly transferable, with minor modifications, to other versions of the NAG C library.  After all Python is quite portable but there may be some differences if you are using a platform wildly different from mine.  Where I am able, I will help people get the examples working on their platform of choice but reserve the right to refer you to the NAG support team if necessary.

Finally, I have developed all of this series using 2.5.2 and have no idea if it will work in later versions or not.

  1. April 1st, 2009 at 08:31
    Reply | Quote | #1

    In numpy/scipy mail lists it is recommended to use Cython instead of other soft for C-Python connections (ctypes, SWIG, Python C API, pyrex). Cython is most recent tool, it have take into account all drawbacks of other soft mentioned, and it is included in numpy as well (along with ctypes).

    Also, I guess you should mention that NAG is commercial software.

  2. Mike Croucher
    April 1st, 2009 at 11:09
    Reply | Quote | #2

    Hi Dmitrey

    Thanks for your comment – I have added a line about the commercial nature of the library to try and make it clearer. Thanks for bringing up cython – I’ll definitely take a look in the future.

    Best wishes,
    Mike

  3. A NAG fan
    September 18th, 2009 at 11:51
    Reply | Quote | #3

    I see you have done this linking with a Linux version of the NAG C Library. How easy might it be to do something similar on Windows? Is there anything I should watch out for?

  4. Mike Croucher
    September 18th, 2009 at 12:52
    Reply | Quote | #4

    Hi

    I don’t think it would be too difficult to do this for Windows – I only stuck to Linux because that’s my preferred platform. Something that immediately springs to mind is that the code for callback functions would be different. If I find time then I’ll investigate and see what I can get working – will probably post something on here eventually if there was sufficient interest.

    My first step would be to decide what Python distribution to use on Windows. I’m thinking either Enthought or Python(x,y) – do you have a preferred choice?

    Cheers,
    Mike

  5. A NAG fan
    September 18th, 2009 at 21:14
    Reply | Quote | #5

    Thanks, I have a whole bunch of friends who love Unix and mentiong Windows is like swearing so your assurance about probably easy is nice to hear. Not yet ready to dive in, but getting tempted. Perhaps we’ll get some input fom others about their experience with Enthought, Python (x,y) or other.

Comments are closed.