#
# 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
#

#
# Release: This file is part of the kim-api-v1.9.3 package.
#


This directory (examples) contains directories with example Model Drivers,
Models, Simulators, and OpenKIM Tests that can be compiled as part of the KIM
API package.  Use `make examples' from the main directory in order to build
the provided examples.

This directory is populated with the provided examples as part of the KIM API
distribution.  Please see the README files within each directory for
information about the examples.

To build and install these examples:

First you must create the file Makefile.KIM_Config in this directory which
points to the installed KIM API library.  When the KIM API is built, this file
is created automatically.  If the file already exists, you can probably skip
this step.

Assuming an installed-(nonstandard)-build and that the KIM API bin directory
has been added to the path.

$ kim-api-v1-build-config --makefile-kim-config > Makefile.KIM_Config

Next, you can execute:

$ make all-system

or

$ make all-user

These will build and install (to the system or user collection, respectively)
all example Model Drivers, then Models.  It will also build the example
Simulators and Tests.

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

$ cd openkim_tests/utility_forces_numer_deriv
$ printf "ex_model_Ar_P_Morse" | ./utility_forces_numer_deriv
