#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the Common Development
# and Distribution License Version 1.0 (the "License").
#
# You can obtain a copy of the license at
# http://www.opensource.org/licenses/CDDL-1.0.  See the License for the
# specific language governing permissions and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each file and
# include the License file in a prominent location with the name LICENSE.CDDL.
# If applicable, add the following below this CDDL HEADER, with the fields
# enclosed by brackets "[]" replaced with your own identifying information:
#
# Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
#
# CDDL HEADER END
#

#
# Copyright (c) 2013--2018, Regents of the University of Minnesota.
# All rights reserved.
#
# Contributors:
#    Ryan S. Elliott
#


This directory (examples) contains directories with example Model Drivers,
Models, and Simulators.  Please see the README files within each directory for
information about the examples.

To build and install these examples:

(Assuming the KIM API has previously been installed and that the KIM API bin
directory is on the path.)

$ make all-user

This will build and install (to the user collection) all example Model Drivers,
then Models.  It will also build the example Simulators.

Once this is complete, you can use the example Simulator inplace.  For example,

$ cd simulators/utility_forces_numer_deriv
$ printf "ex_model_Ar_P_Morse" | ./utilityforces_numer_deriv
