rotal / alembic

Automatically exported from code.google.com/p/alembic
Other
0 stars 0 forks source link

Installation instructions for Alembic

0) Before Alembic can be built, you will need to satisfy its external dependencies. They are, as of July, 2012:

A unix-like OS (Linux, Mac OS X); Windows support is experimental CMake (2.8.0) www.cmake.org Boost (1.44) www.boost.org ilmbase (1.0.3) www.openexr.com HDF5 (1.8.9) www.hdfgroup.org/HDF5 zlib

Optional: pyilmbase (1.0.0) # to build the python bindings Arnold (3.0) Autodesk Maya (2012) Pixar PRMan (15.x) OpenEXR (1.7.1) www.openexr.com Sphinx (1.1.3) # to build the python documentation

Note that the versions given parenthetically above are minimum-tested versions. You may have good luck with later or earlier versions, but this is what we've been building Alembic against.

They may be installed in their default system locations (typically somewhere under /usr/local), or some other centralized directory at your discretion; it's best not to install your dependencies under the Alembic source root. If you do install under a centralized directory you can specify this root in the bootstrap using --dependency-install-root; this will make the process of searching for depedencies go smoothly.

Look in your Alembic source root's "doc" directory for instructions on building Boost and HDF5; see next step for details.

Note: for building the Alembic Python bindings (aka PyAlembic), only Boost versions 1.44 through 1.48 are known to work. For more information see this OpenEXR support ticket on github:

https://github.com/openexr/openexr/issues/41

1) Untar the Alembic source into your desired directory:

$ cd ~/ ; tar xzf ALEMBICSOURCE-xxxxxxxx.tgz

This will create a directory, ~/ALEMBIC_SOURCE, that contains the Alembic source code (if you're reading this, you've probably already done this).

As alluded to in Step 0, ~/ALEMBIC_SOURCE/doc/ will contain instructional files for building Boost and HDF5. Mostly, those packages' libraries just need a little encouragement to build static archives and with -fPIC.

2) The Alembic build bootstrap script assumes an out-of-source build. For purposes of illustration, this document assumes that your build root is located parallel to your source root, though that is not required.

3) Run the Alembic bootstrap script. The following should work:

$ python ~/ALEMBIC_SOURCE/build/bootstrap/alembic_bootstrap.py [build_dir]

You can give it several options and flags; '-h' for a list of them. If you don't specify a complete set of options when you run it, it will prompt you interactively for the information it needs to initialize the build system.

It's worth pointing out that running the bootstrap script is optional; there is a fairly comprehensive set of CMake files there that might just work for you "out of the box". On the other hand, we do strongly recommend running the bootstrapper; it will make things so much easier for you.

4) Once the system is bootstrapped, there will be a file called "CMakeCache.txt" in your build root. You can examine and manipulate this file with the cmake commands "ccmake" (curses-based console program), or "cmake-gui" (Qt-based gui program). This file is the control file for CMake itself; the main thing the bootstrapper does is create it and populate it appropriately (the bootstrap script will also use it to get default values for the things it asks you for).

You can also just edit it directly, if you know what you're doing. If you change it, just be sure to run "cmake ." in the same directory as it so that it regenerates the Makefiles.

5) Run the make command. Kind of a no-brainer, really. You can safely run make with the '-j' flag, for doing multi-process builds. In general, you can profitably run as many "make" processes as you have CPUs, so for a dual-proc machine,

$ make -j2

will build it as quickly as possible. Once the Alembic project has been built, you can optionally run:

$ make test

or,

$ make install

each of which does what you'd expect. Running

$ make help

will give you a list of possible targets. If you want to make a debug build, you can either run the bootstrap script again with the option '--debug', or run ccmake or cmake-gui (depending on what you installed when you installed cmake, as described in 4a), and change the build type to "Debug".

6) To build the API documentation via Doxygen:

$ cd ../ALEMBIC_SOURCE; doxygen Doxyfile

This will generate html documentation in the doc/html folder.

If you get stuck, contact us on the alembic-discussion mailing list. You can view the mailing list archives and join the mailing list via http://groups.google.com/group/alembic-discussion