Directory Structure

Directory Structure

This document describes the directory structure used by this project.

Root directory

• src directory - Source files of Steppable.
• include directory - Header files of Steppable.
• tests directory - Test files of Steppable components.
• tools directory - Tool scripts for the development of Steppable.
• lib directory - Steppable Python bindings.
• res directory - Resource files.

include directory

See the API Reference for more information on Steppable header files.

The CMakeLists.txt in this directory is responsible for adding the correct include directory to all components.

src directory

This directory contains source files of Steppable components and Steppable itself. The files for Steppable itself implements the functions declared in the include files. The source files of components are organized into classes. See the API Reference for more information on these classes.

Only C++ files are present in this directory, the Python source files are either in tools or lib.

The CMakeLists.txt in this directory is responsible for building component executable files and static libraries.

tests directory

This directory contains test files. Each test file compiles into its own executable file, which can then be run directly, or through CTest.

random_tests directory

The random_tests directory contains Python scripts to test the accuracy of the components. Each file starting with test_ runs tests on its corresponding component.

lib directory

This directory contains C++ files for C++-Python bindings. The Python files are part of the Steppable Python library, which are normally used by the tool scripts.

lib/bindings directory

Contains all exposed binding functions to Python.

res directory

This directory contains resource files, like the approximation scripts that are used to compute Padé approximates of functions, and translation files for components.

translations directory

This directory contains the localized string lists for Steppable. The .stp_strings files contains all strings in a component, with their corresponding GUIDs, and the .stp_localized files contains the strings with their GUIDs, but in a localized language.

Tip

The current list of localized languages are:

• zh-HK - Chinese (Hong Kong)
• en-US - English (United States)

tools directory

Contains useful scripts / tools to assist the development of Steppable. Most of them are written in Python.