diff --git a/PyIlmBase/AUTHORS b/PyIlmBase/AUTHORS deleted file mode 100644 index 54d4ecf4..00000000 --- a/PyIlmBase/AUTHORS +++ /dev/null @@ -1,10 +0,0 @@ -Developers: ------------ - -Nick Rasmussen -Phillip Hubbard -Rick Hankins - -Contributors: -------------- - diff --git a/PyIlmBase/COPYING b/PyIlmBase/COPYING deleted file mode 100644 index 6372750d..00000000 --- a/PyIlmBase/COPYING +++ /dev/null @@ -1,34 +0,0 @@ -Copyright (c) 2006, Industrial Light & Magic, a division of Lucasfilm -Entertainment Company Ltd. Portions contributed and copyright held by -others as indicated. All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above - copyright notice, this list of conditions and the following - disclaimer. - - * Redistributions in binary form must reproduce the above - copyright notice, this list of conditions and the following - disclaimer in the documentation and/or other materials provided with - the distribution. - - * Neither the name of Industrial Light & Magic nor the names of - any other contributors to this software may be used to endorse or - promote products derived from this software without specific prior - written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS -IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR -CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, -EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - diff --git a/PyIlmBase/Makefile.am b/PyIlmBase/Makefile.am index a9842b2b..d8ad9cfa 100644 --- a/PyIlmBase/Makefile.am +++ b/PyIlmBase/Makefile.am @@ -19,8 +19,9 @@ DIST_SUBDIRS = \ #vc EXTRA_DIST = \ - AUTHORS COPYING ChangeLog INSTALL LICENSE NEWS \ - README README.OSX bootstrap \ + LICENSE README.md \ + ChangeLog \ + bootstrap \ pyilmbase.m4 \ config.windows/PyIlmBaseConfig.h diff --git a/PyIlmBase/NEWS b/PyIlmBase/NEWS deleted file mode 100644 index 85f279c5..00000000 --- a/PyIlmBase/NEWS +++ /dev/null @@ -1,2 +0,0 @@ -Version 1.0.0: - - Initial release of PyImath and PyIex. diff --git a/PyIlmBase/README.md b/PyIlmBase/README.md new file mode 100644 index 00000000..0fa9be8d --- /dev/null +++ b/PyIlmBase/README.md @@ -0,0 +1,88 @@ +The PyIlmBase Libraries +======================= + +The PyIlmBase libraries provides python bindings for the IlmBase +libraries: + +* **PyIex** - bindings for Iex +* **PyImath** - bindings for Imath +* **PyImathNumpy** - bindings that convert between numpy and Imath arrays + + +If you have questions about using the PyIlmBase libraries, you may want +to join our developer mailing list. See http://www.openexr.com for +details. + + +License +------- + +IlmBase, including all contributions, is released under a modified BSD +license. Please see the ``LICENSE`` file accompanying the distribution +for the legal fine print. + +Dependencies +------------ + +PyIlmBase requires **numpy** to be available to the builder. Install with +your favorite package manager or use a Python virtualenv: + + virtualenv numpy + soure numpy/bin/activate + pip install numpy + +PyIlmBase also requires [boost-python](https://github.com/boostorg/python). + +Building and Installation +------------------------- + +To configure the Makefiles, run the ``configure`` script: + + ./configure + +For help with useful build options: + + ./configure --help + +In particular, arguments of note include: + +* ``--prefix=`` - a directory into which + to install the headers and libraries. By default, headers and + libraries are installed into ``/usr/local``. + +* ``--with-ilmbase-prefix=`` - the direction + into which the IlmBase headers and libraries have been installed, if + not ``/usr/local``. + +* ``--with-boost-include-dir``, ``--with-boost-lib-dir`` - location of + the boost installation. + +To build the libraries after running ``configure``: + + make + make install + +#### Building from Git + +If building directly from a cloned git repo, first generate the +configuration scripts by running ``bootstrap``, then ``configure`` and +``make``: + + cd /IlmBase + ./bootstrap + ./configure + make + make install + +Tests +----- + +Type: + + make check + +to run the PyIlmBase confidence tests (PyIexTest, PyImathTest, +PyImathNumpyTest). They should all pass; if you find a test that does +not pass on your system, please let us know. + +