Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.61 KB

index.rst

File metadata and controls

72 lines (51 loc) · 2.61 KB

Slic User Guide

Slic provides a light-weight, modular and extensible logging infrastructure that simplifies logging application messages.

API Documentation

Doxygen generated API documentation can be found here: API documentation

Key Features

  • Interoperability across the constituent libraries of an application. Messages logged by an application and any of its libraries using Slic have a unified format and routed to a centralized output destination.
  • Customizable :ref:`logMessageFormat` to suit application requirements.
  • Customizable handling and filtering of log messages by extending the :ref:`logStream` base class.
  • :ref:`BuiltInLogStreams` to support common logging use cases, e.g., log to a file or console.
  • Native integration with Lumberjack for logging and filtering of messages at scale.
  • Fortran bindings that provide an idiomatic API for Fortran applications.

Requirements

Slic is designed to be light-weight and self-contained. The only requirement for using Slic is a C++11 compliant compiler. However, to use Slic in the context of a distributed parallel application and in conjunction with Lumberjack, support for building with MPI is provided.

For further information on how to build the Axom Toolkit, consult the Axom Quick Start Guide.

About this Guide

This guide presents core concepts, key capabilities, and guiding design principles of Slic's :ref:`sections/architecture`. To get started with using Slic quickly within an application, see the :ref:`sections/getting_started` section. For more detailed information on the interfaces of the various classes and functions in Slic, developers are advised to consult the Slic Doxygen API.

Additional questions, feature requests or bug reports on Slic can be submitted by creating a new issue on Github or by sending e-mail to the Axom Developers mailing list at axom-dev@llnl.gov.

.. toctree::
   :caption: Contents
   :maxdepth: 3

   sections/getting_started.rst
   sections/architecture.rst
   sections/wrapping_slic_in_macros.rst
   sections/appendix.rst