# Copyright (c) 2024 The YAC Authors
#
# SPDX-License-Identifier: CC-BY-4.0

I.) Documenation
----------------

An extensive documenation with:
* user guide
* interface reference
* release information
* building instructions
* detailed information on interpolation options
* ...

can be found here:

https://dkrz-sw.gitlab-pages.dkrz.de/yac/

II.) Building YAC
-----------------

Examples on how to configure and build yac are provided in the Documenation.

1.) autogen.sh
2.) configure ...
3.) make

Remarks:
  * The weight generated by YAC should be decomposition independent. However,
    compiler optimsations can lead to minimal differences. For Intel this can
    be avoided by compiling with "-fp-model precise".


III.) Testing YAC
-----------------

"make check" will run the test suite.


IV.) Examples
-------------

See the README in the examples directory learn how to
use the Fortran and C user interface. We also provide
examples to test the coupling between realistic grids.
These examples can also be used to study the behaviour
of the various interpolations and the interpolation
stack.


V.) Contact
-----------

Moritz Hanke - hanke at dkrz.de
Rene Redler  - rene.redler at mpimet.mpg.de


VI.) License
------------

BSD License

- see copyright notice in files.
- for mtime source code see COPYING in mtime.