t#
# 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--2014, Regents of the University of Minnesota.
# All rights reserved.
#
# Contributors:
#    Ryan S. Elliott
#    Ellad B. Tadmor
#    Valeriu Smirichinski
#

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


This directory (src) contains the KIM API routines and related files.

The contents of the directory are as follows (before any compilation is
performed):

KIM_API.cpp
     C++ implementations of core library routines and methods.

KIM_API.h
     C++ Header file for KIM API library classes, routines and methods.

KIM_API_C.cpp
     Implementation of C-style interface for the KIM API.

KIM_API_C.h
     Header for C-style interface of KIM API library routines.

KIM_API_DIRS.cpp
     C++ implementation file containing library directory lookup routine (for
     "in-place" and "installed" use of the KIM API library).

KIM_API_DIRS.h
     Header file defining a routine to supply directory locations to be searched
     by the KIM API.

KIM_API_F03.F03
     Implementation of Fortran 2003-style interface for KIM API library.

KIM_API_F03_Helper.F03
     Implementation of helper routines for the Fortran 2003-style interface.

KIM_API_Version.h.tpl
     Template file from which the KIM_API_Version.h header file is created.

KIM_API_status.h
     Header file defining the KIM API status codes.

KIM_AUX.cpp
     C++ implementation file containing auxiliary routines, including
     the native process_dEdr and process_d2Edr2 functions.

KIM_AUX.h
     Header file declaring the auxiliary routines.

Makefile
     Make file for building the KIM API library.

README
     This file.

Unit_Handling.cpp
     C++ implementation file defining the unit handling capabilities of the KIM
     API.

Unit_Handling.h
     Header file declaring the unit handling functions.

model_drivers/
     Each Model Driver is stored in its own directory.  This is where you
     should place Model Driver directories downloaded from https://openkim.org
     for use as "system-wide" drivers.  (Or use `make add-examples' to copy the
     example Model Drivers to this directory.)

models/
     Each Model is stored in its own directory.  This is where you should place
     Model directories downloaded from https://openkim.org for use as
     "system-wide" models.  (Or use `make add-examples' to copy the example
     Models to this directory.)

scripts/
     Directory containing helper scripts for building the KIM API.

standard.kim
     KIM descriptor file with definition and description of all standard
     arguments.

utils/
     Directory containing code for various helper binaries distributed with the
     KIM API.
