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

#
# Release: This file is part of the openkim-api-v1.1.0 package.
#


This directory (KIM_API) contains the openkim-api service routines, as well as
auxiliary files for compiling and testing.

The contents of the directory are as follows:

GNU_compiler_settings.mk
     Make file containing commands and flags for GNU compilers

Include.mk
     Make file used by all makefiles related to KIM.

Intel_compiler_settings.mk
     Make file containing commands and flags for Intel compilers

KIM_API.cpp
     C++ implementations for core service routines and methods.

KIM_API.h
     C++ Header file for KIM API service 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 for KIM API service routines.

KIM_API_Description.txt
     Description of KIM API service routines.

KIM_API_F.F90
     Implementation of Fortran-style interface for KIM API.

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 compiling and building KIM_API using GNU or Intel compilers.

Makefile.Model_Drivers
     Make file for compiling Models based on a Model Driver

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_based_on_driver.cpp
     This file contains the code implementing a Model that is based on a Model Driver.
     It is used by the Makefile.Model_Drivers file.

standard.kim
     kim descriptor file with description of all standard variables.



Files generated automatically as part of 'make all'

model_init_include.cpp
     This file is used in static linking of all Models.

model_init_include.h
     This file is used in static linking of all Models.

.*.make-temp
     These files are used by make to ensure that KIM knows about all models in
     the KIM_MODELS_DIR directory (one file for each model).

.models-deleted
     These files are used by make to detect when one or more models have been
     deleted from the KIM_MODELS_DIR directory.
