Difference between revisions of "Documentation:Running MakeHuman from source"

From MakeHuman Community Wiki
Jump to: navigation, search
(Created page with "There are several reasons why you might want to run MakeHuman from a source snapshot from BitBucket rather than use one of the pre-built packages: * This makes it easy to upd...")
 
Line 10: Line 10:
  
 
* Get a source snapshot from BitBucket
 
* Get a source snapshot from BitBucket
* Install/setup a python environment with [http://www.python.org python 2.7] and the following dependencies installed:
+
* Install/setup a python environment with [http://www.python.org python 2.7] (python later than 2.7 will not work) and the following dependencies installed:
 
** [http://sourceforge.net/projects/numpy/files/NumPy/ NumPy]
 
** [http://sourceforge.net/projects/numpy/files/NumPy/ NumPy]
 
** [http://pyopengl.sourceforge.net/ PyOpenGL]
 
** [http://pyopengl.sourceforge.net/ PyOpenGL]
** [http://www.riverbankcomputing.com/software/pyqt PyQT]
+
** [http://www.riverbankcomputing.com/software/pyqt PyQT] (the required version is pyqt for qt4, qt5 is not supported)
* Run the script for downloading assets
+
* Run the script for downloading assets (this is described in a section at the bottom of the page, after the platform specific notes)
 
* (optionally) run the scripts for compiling assets
 
* (optionally) run the scripts for compiling assets
  
Line 30: Line 30:
  
 
{{#ev:youtube|3CCHGX-6Mtk}}
 
{{#ev:youtube|3CCHGX-6Mtk}}
 +
 +
In general you will need to manually download the installation packages for all the dependencies listed above.
 +
 +
'''IMPORTANT:''' You ''must'' install the same "bittiness" (32-bit or 64-bit) för all packages. While it's possible that you can find 64-bit packages for everything, it's probably easier to go for 32-bit packages even on a 64-bit system.
 +
 +
There are several mercurial clients for windows, but one of the more popular ones is [http://tortoisehg.bitbucket.org/ TortoiseHG].
 +
 +
== Running from source on Linux ==
 +
 +
Running from source on Linux is generally trivial since all the dependencies are available via the package management.
 +
 +
For Ubuntu and Debian, there is [https://bitbucket.org/MakeHuman/makehuman/src/179e10c2b9440f73f6d154839e8720e1dccf39cd/buildscripts/deb/install_deb_dependencies.bash?at=stable&fileviewer=file-view-default a script] for installing all the required dependencies.
 +
 +
If you are not using a debian derivate, you will need to figure out that the dependencies are called on your platform. You will probably want at least:
 +
 +
* python 2.7
 +
* python-numpy
 +
* python-opengl
 +
* qt4
 +
* python-qt4
 +
* python-qt4-gl
 +
 +
For example on ubuntu:
 +
 +
  sudo apt-get install python python-numpy python-opengl qt4 python-qt4 python-qt4-gl
 +
 +
The mercurial client is also available in most linux distributions. In ubuntu it's called "mercurial". For example:
 +
 +
  sudo apt-get install mercurial
 +
 +
To get a source snapshot from bitbucket run:
 +
 +
  hg clone https://joepal1976@bitbucket.org/MakeHuman/makehuman
 +
  cd makehuman
 +
  hg update -C stable
 +
 +
== Download and compilation scripts ==
 +
 +
Once you have an environment with the dependencies installed, and a source snapshot, there are a few scripts that should normally be run. They are available in the "makehuman" directory and
 +
should probably be run in this order:
 +
 +
* download_assets.py (this is required, and will dowload all clothes etc)
 +
* compile_targets.py (these three are optional but will make starting makehuman faster)
 +
* compile_models.py
 +
* compile_proxies.py
 +
 +
== Starting makehuman ==
 +
 +
With all the above, simply run the "makehuman.py" script either by double-clicking on it or by executing it from a console prompt.

Revision as of 08:28, 31 May 2016

There are several reasons why you might want to run MakeHuman from a source snapshot from BitBucket rather than use one of the pre-built packages:

  • This makes it easy to update and get the latest features
  • You get full access to all assets (in the builds the assets are only available in compiled archives)
  • It's possible there is no functional pre-built package for your platform.

Overview

In order to run from source, you need the following:

  • Get a source snapshot from BitBucket
  • Install/setup a python environment with python 2.7 (python later than 2.7 will not work) and the following dependencies installed:
  • Run the script for downloading assets (this is described in a section at the bottom of the page, after the platform specific notes)
  • (optionally) run the scripts for compiling assets

Getting the source from Bitbucket

At this point in time it's recommended you run from the "stable" branch. If you're feeling adventurous, you can run "default", but in more cases than not this will crash for you.

The quickest way to get the source is to download is as a zip at https://bitbucket.org/MakeHuman/makehuman/get/stable.zip

However, if you plan to update in the future, you will want to install a mercurial client and check out a source clone. This looks different depending on platform.

Running from source on Windows

Setting up the environment on Windows is normally somewhat cumbersome. However, there is a tutorial video on how to do this:

In general you will need to manually download the installation packages for all the dependencies listed above.

IMPORTANT: You must install the same "bittiness" (32-bit or 64-bit) för all packages. While it's possible that you can find 64-bit packages for everything, it's probably easier to go for 32-bit packages even on a 64-bit system.

There are several mercurial clients for windows, but one of the more popular ones is TortoiseHG.

Running from source on Linux

Running from source on Linux is generally trivial since all the dependencies are available via the package management.

For Ubuntu and Debian, there is a script for installing all the required dependencies.

If you are not using a debian derivate, you will need to figure out that the dependencies are called on your platform. You will probably want at least:

  • python 2.7
  • python-numpy
  • python-opengl
  • qt4
  • python-qt4
  • python-qt4-gl

For example on ubuntu:

 sudo apt-get install python python-numpy python-opengl qt4 python-qt4 python-qt4-gl

The mercurial client is also available in most linux distributions. In ubuntu it's called "mercurial". For example:

 sudo apt-get install mercurial

To get a source snapshot from bitbucket run:

 hg clone https://joepal1976@bitbucket.org/MakeHuman/makehuman
 cd makehuman
 hg update -C stable

Download and compilation scripts

Once you have an environment with the dependencies installed, and a source snapshot, there are a few scripts that should normally be run. They are available in the "makehuman" directory and should probably be run in this order:

  • download_assets.py (this is required, and will dowload all clothes etc)
  • compile_targets.py (these three are optional but will make starting makehuman faster)
  • compile_models.py
  • compile_proxies.py

Starting makehuman

With all the above, simply run the "makehuman.py" script either by double-clicking on it or by executing it from a console prompt.