mylbrinkerhoff / artisynth_core Goto Github PK

This is the core distribution of ArtiSynth, a 3D mechanical modeling
system that supports the combined simulation of multibody and finite
element models, together with contact and constraints.  While targeted
at biomechanical and biomedical applications, it can also be used for
general purpose mechanical simulation. It is freely available under a
two-clause BSD-style open source license.

The system is implemented in Java, and provides a rich set of modeling
components, including particles, rigid bodies, finite elements with
both linear and nonlinear materials, point-to-point muscles, and
various bilateral and unilateral constraints including contact. A
graphical interface allows interactive component navigation, model
editing, and simulation control.

Full details, videos and documentation are provided on the ArtiSynth
website at https://www.artisynth.org.

For details on how to install artisynth_core from Github, see the
section "Cloning from Github" in the installation guide appropriate to
your system at https://www.artisynth.org/doc/info/installation.

=======================================================================

Files in this directory:

.artisynthInit
    Default ArtiSynth initialization file

.classpath
    Classpath information used by the Eclipse IDE

.demoModels 
    List of "banner" demo models available when ArtiSynth starts up

.git*
    If present, contain repository and configuration information used
    by the Git SCM. 

.mainModels 
    List of "banner" anatomical models in the ArtiSynth Models package
    (which must be installed).

.project
    Project information used by the Eclipse IDE

ArtiSynth.launch
    Default "launch" configuration for used by the Eclipse IDE

ArtiSynth_launch
    Backup copy of the default version of ArtiSynth.launch

.settings/
    Settings information used by the Eclipse IDE

DISTRO_EXCLUDE
    Describes any files that should be excluded from the current
    precompiled distribution.

EXTCLASSPATH.sample
    Example EXTCLASSPATH file. An EXTCLASSPATH files indicates to the
    ArtiSynth Launcher additional classpaths that should be used when
    searching for models.

LICENSE
    Licensing and terms of use

Makefile
    Makefile for compiling and doing certain maintenance operations in
    a shell environment.

Makefile.base
    Base definitions for Makefile and Makefile in subdirectories.

README
    This file

VERSION
    Current version

bin/
    Stand-alone programs, mostly implemented as scripts. 
    The program 'artisynth' starts up the ArtiSynth system.

classes/
    Root directory for compiled classes (created on demand)

demoMenu.xml
    Default format for the Models menu

doc/
    System documenation

eclipseSettings.zip
    Default project settings for the Eclipse IDE (obsolete since these
    are now checked directly into the repository)

lib/
    Java libraries, plus architecture-specific libraries for native code
    support, mostly involving linear solvers, Java OpenGL (JOGL), and
    collision detection

matlab/
    Matlab scripts for running ArtiSynth from matlab

models.xml
    Alternative format for the Models menu
    
scripts/
    Jython scripts for basic testing, etc. Some of these may assume
    the installation of additional projects.

setup.bash
    Example ArtiSynth setup script for bash

setup.csh
    Example ArtiSynth setup script for chs/tcsh

src/
    ArtiSynth source code

support/
    Configuration information for external IDEs and support software,
    including default settings for the Eclipse IDE.

tmp/
    Temp directory for operations like storing files when making
    movies.