mirror of
https://github.com/boostorg/python.git
synced 2026-01-20 16:52:15 +00:00
80 lines
2.6 KiB
Plaintext
80 lines
2.6 KiB
Plaintext
Boost.NumPy is an extension for Boost.Python that adds NumPy support.
|
|
|
|
It is intended as a replacement for the old numeric support in
|
|
Boost.Python proper, which is now out-of-date and does not support
|
|
C/C++ pointer access to the data. Because it builds against the NumPy
|
|
headers and hence has a dependency that Boost.Python does not, it is
|
|
intended to be built as a separate library. This is also not intended
|
|
to be a high-level C++ array library; it would be more accurate to
|
|
consider it a C++ NumPy API, with the intent of making the NumPy C-API
|
|
available in a form that is safer and more convenient for C++ users
|
|
(and particularly those using Boost.Python, of course).
|
|
|
|
THIS IS NOT AN OFFICIAL BOOST LIBRARY
|
|
|
|
...we're just calling it Boost.NumPy right now because that clearly
|
|
indicates that it's for Boost.Python and NumPy. We do intend to
|
|
propose it for inclusion in Boost eventually.
|
|
|
|
|
|
INSTALLATION
|
|
|
|
We have provided both a Boost.Build and an SCons build system. At
|
|
the moment, we recommend using the latter. Building should be as
|
|
simple as running "scons" and "scons install", but you may need
|
|
to use the "--with-boost*" options (see "scons --help") to specify
|
|
where to find Boost. The Python that is used by SCons will
|
|
be the one built against.
|
|
|
|
|
|
DOCUMENTATION
|
|
|
|
More documentation on how to use the library can be found in
|
|
libs/numpy/doc, but it may be most useful to start with the
|
|
examples in libs/numpy/examples. The headers files are also
|
|
well documented and are intended to serve as a reference.
|
|
|
|
|
|
ISSUES AND NEW FEATURES
|
|
|
|
Please create an issue on the GitHub site at:
|
|
|
|
https://github.com/ndarray/Boost.NumPy/issues
|
|
|
|
|
|
CONTACT
|
|
|
|
Please send email questions to:
|
|
|
|
ndarray-dev@googlegroups.com
|
|
|
|
...but I would prefer bug reports and feature requests to go to
|
|
the GitHub issues list (see above).
|
|
|
|
|
|
MULTI-PLATFORM SUPPORT
|
|
|
|
The vast majority of development has happened on Linux/g++, and while
|
|
we have taken some steps to support MacOS/clang, there hasn't been
|
|
much testing. There has been no testing on Windows, though we have
|
|
no reason to believe anything we've done won't work on Windows.
|
|
|
|
In short, we'd really love to have some testing on additional platforms,
|
|
especially from people who know their way around SCons, NumPy, or
|
|
Boost.Python.
|
|
|
|
|
|
HISTORY/AUTHORS
|
|
|
|
Boost.NumPy was originally written by Jim Bosch as part of the
|
|
"ndarray" C++ library, then reorganized into a standalone component,
|
|
cleaned up, and documented as part of a Boost-sponsored
|
|
Google Summer of Code by Ankit Daftery, mentored by Stefan Seefeld.
|
|
|
|
The project is hosted both on the Boost Sandbox:
|
|
|
|
https://svn.boost.org/svn/boost/sandbox/numpy
|
|
|
|
and on GitHub:
|
|
|
|
https://github.com/ndarray/Boost.NumPy |