Vtkski development - Revision history

Enodwell at 15:43, 8 November 2010

2010-11-08T15:43:51Z

← Older revision		Revision as of 15:43, 8 November 2010
Line 2:		Line 2:

	On-line documentation for vtkski is available at http://mike.kin.ucalgary.ca/vtkski/ .		On-line documentation for vtkski is available at http://mike.kin.ucalgary.ca/vtkski/ .

	~~Also, see [[vtkMeshModel]] which contains some examples of using the class vtkMeshModel .~~

	==Building vtkski==		==Building vtkski==

Enodwell at 15:39, 9 June 2010

2010-06-09T15:39:03Z

← Older revision		Revision as of 15:39, 9 June 2010
Line 7:		Line 7:
	==Building vtkski==		==Building vtkski==

	See [[Bone lab libraries:Build Instructions]] .		See [[Bone lab libraries#Build Instructions]] .

	==Checklist for new vtkski classes==		==Checklist for new vtkski classes==

Enodwell at 15:38, 9 June 2010

2010-06-09T15:38:47Z

← Older revision		Revision as of 15:38, 9 June 2010
Line 4:		Line 4:

	Also, see [[vtkMeshModel]] which contains some examples of using the class vtkMeshModel .		Also, see [[vtkMeshModel]] which contains some examples of using the class vtkMeshModel .

			==Building vtkski==

			See [[Bone lab libraries:Build Instructions]] .

	==Checklist for new vtkski classes==		==Checklist for new vtkski classes==

Enodwell at 15:19, 9 June 2010

2010-06-09T15:19:12Z

← Older revision		Revision as of 15:19, 9 June 2010
Line 4:		Line 4:

	Also, see [[vtkMeshModel]] which contains some examples of using the class vtkMeshModel .		Also, see [[vtkMeshModel]] which contains some examples of using the class vtkMeshModel .

	~~==Compiling and Installation==~~

	~~===Getting the source code===~~

	~~Choose a place in your home directory that you want to use for the source code. For example~~

	~~mkdir -p ~/code~~
	~~cd ~/code~~

	~~(Note that '~' gets automatically expanded to your home directory.)~~

	~~Get the sources from the subversion repository.~~

	~~svn checkout https://mike.kin.ucalgary.ca/svn/bonelab/trunk~~

	~~See the section on svn for more info: [[Subversion (SVN)]] .~~

	~~===Compiling===~~

	~~From the vtkski project directory, create a build directory in trunk/Libraries and use cmake to configure the build:~~

	~~mkdir build~~
	~~cd build~~
	~~cmake-gui ..~~

	~~Here are some typical configuration options:~~

	~~{\| border="1" cellpadding="2" cellspacing="0"~~
	\|-
	~~! option~~
	~~! Setting~~
	~~! Comments~~
	~~\|- valign="top"~~
	\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK. If you intend to build the paraview extensions as plugins, then you set this to the internal version of VTK inside the paraview build directory. (See [[Paraview development]] if you need to install ParaView).
	~~\|- valign="top"~~
	~~\| BONELAB_BUILD_LIBRARY_itkski \|\| ON/OFF \|\| Set this to OFF if you don't want to build itkski as well. In this case you won't need to have ITK installed or specify where it can be found.~~
	~~\|- valign="top"~~
	~~\| ITK_DIR \|\| /opt/itk-3.18.0/lib/InsightToolkit \|\| You only need to set this if BONELAB_BUILD_LIBRARY_itkski is ON. In that case, set it to herever you installed ITK.~~
	~~\|- valign="top"~~
	\| Boost_INCLUDE_DIR \|\| /opt/boost-1.42.0/include \|\| Set this to wherever you installed boost. Note that this is an Advanced setting, and you won't see it until you toggle to Advanced view. Don't worry about all the Boost libraries it doesn't find; as soon as Boost_INCLUDE_DIR is properly set, it will find them.
	\|}

	Once you're happy with your settings, hit Configure. You might have to hit it a couple of times until there are no more errors, and the Generate button is enabled. Then hit Generate and quite cmake-gui.

	~~Now run:~~

	~~make~~

	~~You won't usually need to run a 'make install', since you can just use vtkski from your build directory.~~

	~~===Building Doxygen documentation===~~

	~~This is an advanced topic. Most users can just refer to the documentation here: http://mike.kin.ucalgary.ca/vtkski/ .~~

	To build the Doxygen documentation, set the cmake variable BUILD_DOCUMENTATION to ON. This variable is marked as advanced. You will need to have installed Doxygen ( http://www.doxygen.org/ ) in order to build the documentation.

	~~The documentation is not automatically built with make (it takes a very long time to build). Instead, you will need to explicitly request it, like this:~~
	~~make vtkskiDoxygenDoc~~

	~~====Installing the Doxygen documentation on mike.kin====~~

	I recommend that you build the documentation with the cmake flag DOCUMENTATION_HTML_TARZ set to on (this variable is an advanced setting). Then the build process will automatically make a tar ball of all the HTML documentation, build/Utilities/Doxygen/vtkski-html.tar.gz , which is easy to copy over to mik.kin (using FTP or scp or the mounted Data0 volume).

	~~The documentation needs to live in /Library/WebServer/Documents/vtkski . The commands would look something like this~~
	~~tar xvzf vtkski-html.tar.gz~~
	~~sudo rm -rf /Library/WebServer/Documents/vtkski # remove old docs~~
	~~sudo mv html /Library/WebServer/Documents/vtkski~~
	~~sudo chown -R root /Library/WebServer/Documents/vtkski~~

	==Checklist for new vtkski classes==		==Checklist for new vtkski classes==

Enodwell: /* Building Doxygen documentation */

2010-06-09T15:04:18Z

Building Doxygen documentation

← Older revision		Revision as of 15:04, 9 June 2010
Line 56:		Line 56:

	===Building Doxygen documentation===		===Building Doxygen documentation===

			This is an advanced topic. Most users can just refer to the documentation here: http://mike.kin.ucalgary.ca/vtkski/ .

	To build the Doxygen documentation, set the cmake variable BUILD_DOCUMENTATION to ON. This variable is marked as advanced. You will need to have installed Doxygen ( http://www.doxygen.org/ ) in order to build the documentation.		To build the Doxygen documentation, set the cmake variable BUILD_DOCUMENTATION to ON. This variable is marked as advanced. You will need to have installed Doxygen ( http://www.doxygen.org/ ) in order to build the documentation.

Enodwell: /* Compiling */

2010-06-09T15:02:52Z

Compiling

← Older revision		Revision as of 15:02, 9 June 2010
Line 38:		Line 38:
	! Comments		! Comments
	\|- valign="top"		\|- valign="top"
	\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK.		\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK. If you intend to build the paraview extensions as plugins, then you set this to the internal version of VTK inside the paraview build directory. (See [[Paraview development]] if you need to install ParaView).
	\|- valign="top"		\|- valign="top"
	\| BONELAB_BUILD_LIBRARY_itkski \|\| ON/OFF \|\| Set this to OFF if you don't want to build itkski as well. In this case you won't need to have ITK installed or specify where it can be found.		\| BONELAB_BUILD_LIBRARY_itkski \|\| ON/OFF \|\| Set this to OFF if you don't want to build itkski as well. In this case you won't need to have ITK installed or specify where it can be found.
Line 47:		Line 47:
	\|}		\|}

			Once you're happy with your settings, hit Configure. You might have to hit it a couple of times until there are no more errors, and the Generate button is enabled. Then hit Generate and quite cmake-gui.

			Now run:
	The most important cmake variable is <tt>VTK_DIR</tt>. If you intend to also build the paraview plugins, then you must build vtkski against the internal version of VTK inside the paraview build directory. (See [[Paraview development]] if you need to install ParaView). As an example, on my system I set <tt>VTK_DIR</tt> to <tt>/home/eric/source/paraview-3.8.0/build/VTK</tt>. You will also need to specify the boost include directory.

	~~Then within build directory~~ run:

	make		make

Enodwell: /* Compiling */

2010-06-09T15:00:00Z

Compiling

← Older revision		Revision as of 15:00, 9 June 2010
Line 38:		Line 38:
	! Comments		! Comments
	\|- valign="top"		\|- valign="top"
	\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK		\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK.
	\|- valign="top"		\|- valign="top"
	\| BONELAB_BUILD_LIBRARY_itkski \|\| ON/OFF \|\| Set this to OFF if you don't want to build itkski as well. In this case you won't need to have ITK installed or specify where it can be found.		\| BONELAB_BUILD_LIBRARY_itkski \|\| ON/OFF \|\| Set this to OFF if you don't want to build itkski as well. In this case you won't need to have ITK installed or specify where it can be found.
			\|- valign="top"
			\| ITK_DIR \|\| /opt/itk-3.18.0/lib/InsightToolkit \|\| You only need to set this if BONELAB_BUILD_LIBRARY_itkski is ON. In that case, set it to herever you installed ITK.
			\|- valign="top"
			\| Boost_INCLUDE_DIR \|\| /opt/boost-1.42.0/include \|\| Set this to wherever you installed boost. Note that this is an Advanced setting, and you won't see it until you toggle to Advanced view. Don't worry about all the Boost libraries it doesn't find; as soon as Boost_INCLUDE_DIR is properly set, it will find them.
	\|}		\|}

Enodwell: /* Compiling */

2010-06-09T14:56:23Z

Compiling

← Older revision		Revision as of 14:56, 9 June 2010
Line 50:		Line 50:

	make		make

			You won't usually need to run a 'make install', since you can just use vtkski from your build directory.

	===Building Doxygen documentation===		===Building Doxygen documentation===

Enodwell: /* Getting the source code */

2010-06-09T14:55:27Z

Getting the source code

← Older revision		Revision as of 14:55, 9 June 2010
Line 8:		Line 8:

	===Getting the source code===		===Getting the source code===

			Choose a place in your home directory that you want to use for the source code. For example

			mkdir -p ~/code
			cd ~/code

			(Note that '~' gets automatically expanded to your home directory.)

	Get the sources from the subversion repository.		Get the sources from the subversion repository.

Enodwell: /* Compiling */

2010-06-09T14:54:07Z

Compiling

← Older revision		Revision as of 14:54, 9 June 2010
Line 32:		Line 32:
	\|- valign="top"		\|- valign="top"
	\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK		\| VTK_DIR \|\| /opt/vtk-5.6.0/lib/vtk-5.6 \|\| Set this to wherever you installed VTK
			\|- valign="top"
			\| BONELAB_BUILD_LIBRARY_itkski \|\| ON/OFF \|\| Set this to OFF if you don't want to build itkski as well. In this case you won't need to have ITK installed or specify where it can be found.
	\|}		\|}