Skip to content

Latest commit

 

History

History
247 lines (193 loc) · 7.85 KB

aot_mainpage.md

File metadata and controls

247 lines (193 loc) · 7.85 KB
Raw

project: Aotus summary: A Fortran wrapper around the C-API of Lua, for usage as configuration. src_dir: source src_dir: LuaFortran page_dir: doc_pages output_dir: docu project_website: https://apes-suite.github.io/pages/aotus graph: true display: public display: protected display: private print_creation_date: True sort: permission source: true externalize: true author: University of Siegen exclude: dummy_extdouble_fun_module.f90 exclude: dummy_extdouble_out_module.f90 exclude: dummy_extdouble_table_module.f90 exclude: dummy_extdouble_top_module.f90 exclude: dummy_extdouble_vector_module.f90 exclude: dummy_quadruple_fun_module.f90 exclude: dummy_quadruple_out_module.f90 exclude: dummy_quadruple_table_module.f90 exclude: dummy_quadruple_top_module.f90 exclude: dummy_quadruple_vector_module.f90

Advanced Options and Tables in Universal Scripting

The Aotus library provides a Fortran wrapper around the C-API of the Lua scripting language, allowing a convenient usage of Lua scripts as configuration files in Fortran applications.

It is available for download from Github.

This library is released under a simplified MIT licence, please have a look into the LICENSE file for details.

Aotus is part of the APES suite.

How To Build

Waf is used as build system.

Run:

./waf configure build

to build the Aotus library. If you want to select a specific Fortran compiler, set the environment variable FC. And for a specific C compiler, set the environment variable CC. The Fortran compiler flags are set with the help of fcopts, which provide a set of compiler flag combinations for various compilers. They are found in the fortran_compiler.py file in the root directory of the project.

By running:

./waf --help

you get a list of available options to the waf script.

Generating a Makefile

If you do not want to use waf for the actual compilation of the project, you can generate a Makefile with waf by running the dump command. To resemble more closely the usual auto-tool steps, there is a configure script to run the configuration phase of waf and the generation of the Makefile. This will create a Makefile in the build subdirectory, so you can compile aotus with:

./configure
cd build
make

You can get a list of available options by running

./configure --help

Build with the smeka system

The Aotus library can also be built by using the provided Makefile.smeka, which utilizes the smeka build system.

This build system requires the compilation in a subdirectory. A minimal compilation (defaulting to the GNU compiler suite, gfortran/gcc) is achieved by running:

mkdir build
cd build
{
echo 'TOP_DIR = ..'
echo 'include $(TOP_DIR)/Makefile.smeka'
} > Makefile
make

and the resulting libaotus.a will be put in that directory. To control the compiler flags you may create a file setup.make, which can define the usual FC, FFLAGS, CC, CFLAGS, INCLUDES and LIBS variables which are used for compilation, and linking. For instance, to compile with just the -g flag, you can use:

{
echo FFLAGS = -g
echo CFLAGS = -g
} > setup.make

Note that the default compiler is still the GNU suite.

Aotus may be built with two variations of extended precisions. They may individually be turned on by setting these variables:

EXTDOUBLE = 1 # defaults to 0 == do not build with extended double
QUADRUPLE = 1 # defaults to 0 == do not build with quadruple double

To install the library together with the modules in a given directory, you can run:

make install PREFIX=$HOME/aotus

This will create bin/, include/ and lib/ directories within the PREFIX path with the typical libraries and modules.

NOTE: Currently liblua.a is not added to the archive, this may easily be achieved by performing this shell command (after having run make)

rm libaotus.a
ar -ru libaotus.a *.o
ranlib libaotus.a

What is Built

For your convenience the Lua library is included in version 5.4.6 (released 2023-05-14). Its objects are completely gathered into the final libaotus library, so it is only necessary to link against this single static library to gain the configuration features of aotus in your Fortran application. Due to the compiler specific module information required by any application using the libaotus, the suggested approach to incorporate libaotus is to include its building in the build process of the final application. This is straight forward if waf is used for the complete project. But also in other build environments it should not be too hard to make use of the generated build directory. Yet if you would rather install the libaotus.a and the module files into a $PREFIX directory, you can make use of:

./waf install

The default build process will also create some unit test executables and execute them to ensure functionality of the various parts in the library.

The documentation can be built with FORD by running:

ford aot_mainpage.md

This will build a docu directory with the resulting documentation. Note, that this requires FORD to be installed beforehand. This documentation is also online available at our server.

Example

There is an example program built, called aotus_sample, which you will find in the build directory. It can be used with the provided config.lua in the sample directory, where also the source of this small program is found.

Getting Started

The central module in this library is the [[aotus_module]]. Its documentation and the Aotus overview would be good starting points.

Related Projects

Some projects with similar goals or related information:

License

Aotus is licensed under the terms of the MIT license reproduced below. This means that Aotus is free software and can be used for both academic and commercial purposes at absolutely no cost. You are free to do with the code whatever you want. The only requirement is that some credit to the authors is given by putting this copyright notice somewhere in your project. The MIT license is chosen for full compatibility with Lua.

For the license of the underlying Lua library have a look at http://www.lua.org/license.html.

See individual files for the respective copyright holders.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.