For most users doing active modeling work, we recommend installing the current ArtiSynth development version from GitHub, which will provide ongoing access to updates and bug fixes. GitHub is a web-based repository service based on the source control management system Git. A very brief summary of Git is given in Section 13.5.
ArtiSynth is available from GitHub at the URL
After installation, users can continually update the ArtiSynth codebase to the latest version using pull operations (Section 11). In some cases, developers we work with closely can also obtain, by mutual arrangement, write access to our GitHub repository, allowing them to also commit changes.
Users who have a GitHub account combined with SSH keys may instead wish to clone using the SSH URLgit@github.com:artisynth/artisynth_core.git
For users with repository write access, this will allow them to perform subsequent push operations without having to enter a username and password.
If you are planning to use the Eclipse IDE (Section 12), you can install from GitHub directly into Eclipse. Directions on installing Eclipse and configuring it for ArtiSynth development are given in Section 12.1. Once Eclipse is installed, ArtiSynth can be installed as follows:
From the main menu, select “File > Import ...”. This will cause an Import dialog to appear, as shown below. Open “Git > Projects from Git”, and then click Next.
In the next dialog, choose Clone URI, and click Next.
A Source Git Repository dialog will appear, as shown
In the URI field at the top, enter
This will automatically fill the Host and Repository path fields. Click Next.
A Branch Selection dialog will appear; uncheck svn, so that only master is selected. Click Next.
A Local Destination dialog will appear as shown below, indicating the folder into which ArtiSynth will be placed locally. Use the default location, or edit it to the desired location. This will be your ArtiSynth home folder, and will be referred to later in this document as <ARTISYNTH_HOME>. Click Next.
ArtiSynth will now be downloaded; this may take a few minutes, depending on your network connection speed. Another dialog will appear, asking you to select to project import wizard. Leave the default (“Import existing Eclipse projects”) selected, and click Next.
An Import Projects dialog will appear, confirming that you want to import artisynth_core. Leave everything as is, and click Finish.
artisynth_core has now been imported into Eclipse as a project. However, we are not quite done. Eclipse will try to compile artisynth_core, but will fail because some Java and native libraries are missing. (These libraries are not included in the GitHub repository because they are quite large.) The compile failure will be indicated by a red exclamation mark to the left of the artisynth_core project entry in the Package Explorer:
The Java and native libraries must be downloaded separately, outside of Eclipse. Open a file explorer, navigate to the <ARTISYNTH_HOME> folder (described above), open the bin folder, and click on the updateArtisynthLibs batch file (Figure 1). This will load the libraries, temporarily displaying a terminal window while doing so. The process may take a few minutes, depending on network speed.
When the libraries are loaded, return to Eclipse, click on the artisynth_core project to select it, then “refresh”, either by right clicking and selecting Refresh, or by hitting the F5 key. Eclipse should now find the libraries and compile ArtiSynth; a green progress bar will appear at the lower right while compilation is in progress.
After compilation is complete, ArtiSynth can be run by simply choosing Run > Run from the main menu. This works by invoking a predefined launch configuration named ArtiSynth. In some cases, one may wish to adjust this launch configuration to set environment variables, command line arguments, or Java JVM arguments that affect how ArtiSynth behaves. Instructions for doing so are contained in Sections 12.3 and 12.4.
Git for Windows is an application that provides the user with a terminal window interface that can be used for entering Git commands. Users can choose between GitBash, which provides a Unix-like bash shell, or GitCMD, which provides a Windows CMD shell. GitBash has several advantages, such as allowing users to easily set environment variables in a .bashrc file (Section 13.2.3), and supplying a number of Unix-like commands that can be convenient for tasks other than those involving Git.
At the time of this writing, Git for Windows can be installed from git-scm.com/download/win.
Once installed, ArtiSynth can then be installed and compiled by opening a GitBash window and entering the following commands (where the ‘$’ character indicates the GitBash prompt and should not be entered):
The first line simply sets the current folder to the one under which you wish to install ArtiSynth, as indicated by /path/to/install. (Note that GitBash follows the Unix convention of using forward slash (’/’) instead of backslash (’\’) to separate files.) The git clone command then downloads ArtiSynth and extracts it to a folder named artisynth_core, so that the ArtiSynth installation directory (or <ARTISYNTH_HOME>) is/path/to/install/artisynth_core. The updateArtisynthLibs command fetches additional libraries that are not included in the GitHub repository for space reasons, and the make command on the last line is a Unix build utility provided by GitBash; in this situation, it compiles all the .java files under artisynth_core.
Once built, ArtiSynth can then be run (from within artisynth_core) using the command
For convenience, if you place <ARTISYNTH_HOME>\bin in your Path environment variable (Section 13.1), then ArtiSynth can be run independently of the current directory using the simple command% artisynth
ArtiSynth can also be installed and compiled using GitCMD, with an analogous command sequence:
The only real difference is using backslash (’\’) instead of forward slash (’/’) as a file separator, and the use of bin\compile instead of make (which is not supported in Git CMD). compile is a command supplied by ArtiSynth that compiles all .java files located under the current folder.
Details on how to load and run demo models are given in Section 7.
Note that once you have installed ArtiSynth, you still have the option to later import it into an IDE such as Eclipse. For Eclipse specifically, this is done by importing it as an external project, as described in Section 12.2.