ArtiSynth Installation Guide for Windows

11 Installing artisynth_models

artisynth_models is an open source collection of anatomical models, focused primarily on the head and neck region (see www.artisynth.org/models). It can be obtained either as a precompiled release, or from GitHub.

Once installed, the models will appear in the ArtiSynth Models menu under Models > and All models >.

11.1 Installing a precompiled release

If you are running a precompiled release of ArtiSynth, then you will need to use the corresponding precompiled release of artisynth_models, which can be obtained from

  www.artisynth.org/Software/ModelsDownload

Download the distribution you want and unzip it in your desired location; the recommended spot is right next to artisynth_core.

artisynth_models comes preconfigured with Eclipse project files, and so can be immediately imported into Eclipse as an external project, as described in Section 13.2. To make the models visible to ArtiSynth when running from Eclipse, it will be necessary to add artisynth_models to the ArtiSynth launch configuration, as described in Section 13.6.

If you are running ArtiSynth from the command line or the artisynth.bat file, you will need to ensure that the class folder artisynth_models\classes is visible to ArtiSynth, as described in Section 10.2.

11.2 Installing from GitHub

The latest development version of artisynth_models is available from GitHub at the URL

   https://github.com/artisynth/artisynth_models.git

11.2.1 Installation using Eclipse

If you are using Eclipse, you can install artisynth_models in the same way as for artisynth_core (Section 6.1):

  1. 1.

    Select “File > Import ...”, open “Git > Projects from Git” in the Import dialog, and click Next.

  2. 2.

    In the Select Repository Source dialog, choose Clone URI, and click Next.

  3. 3.

    In the Source Git Repository dialog, enter
    https://github.com/artisynth/artisynth_models.git
    in the URI field at the top, and click Next.

  4. 4.

    In the Branch Selection dialog, uncheck svn and click Next.

  5. 5.

    In the Local Destination dialog, adjust the install location if desired, and click Next.

  6. 6.

    artisynth_models will now be downloaded. A “wizard” dialog will then appear. Leave the default (“Import existing Eclipse projects”) selected, and click Next.

  7. 7.

    In the Import Projects dialog, click Finish.

artisynth_models should now compile automatically; there is no need to download external libraries. However, to make the models visible to ArtiSynth when running from Eclipse, it will be necessary to add artisynth_models to the ArtiSynth launch configuration, as described in Section 13.6.

11.2.2 Installation using Git for Windows

If you have Git for Windows installed (Section 6.2), and you have placed <ARTISYNTH_HOME>\bin in your Path environment variable (Section 14.1), allowing the compile command to be called from any folder, then artisynth_models can be installed from GitBash as follows:

⬇
 $ cd /path/to/install
 $ git clone https://github.com/artisynth/artisynth_models
 $ cd artisynth_models
 $ compile

The last line uses the compile command instead of make because the latter will not work unless the CLASSPATH environment variable has been set to include the ArtiSynth class path entries, as described in Section 10.1.2.

If you run ArtiSynth from the command line, you will need to ensure that artisynth_models\classes is visible to ArtiSynth, as described in Section 10.2.