The Protium Libraries

Table of Contents

• Introduction
• Downloading Software
• Dependencies
• Building
  • Unix-Like Systems
  • Windows
• Running
• Code Hierarchy
• Contact

Introduction

The Tritium APIs are designed to provide a highly modular approach to cross-machine analysis and simulation tasks. The API's are split into 3 levels to isolate functionality between systems to avoid a "Do-All" API.

The three API's are:

• Protium
  • Base framework and primitive functionality.
  • Designed to run on low-level systems.
• Deuterium
  • Networking and Filesystem functionality. Future scripting functionality.
  • Designed to run on host-side machines.
• Tritium
  • Graphics and advanced mathematical functionality.
  • Designed to run on client machines.

Downloading Software

This software is hosted on GitHub. The URL for the repository is: https://github.com/kwierman/Protium .

Pulling from the repository can be accomplished by downloading Git

git clone https://github.com/kwierman/Protium.git

It is advisable that if the software is being worked on to create a separate branch. This can be accomplished with the following line:

git checkout -b <your_branch_name>

Pushing to the repository can be accomplished with the following command:

git push -u origin <your_branch_name>

---

Dependencies

The following libraries must be built and in the paths in order to build properly:

• CMake
  • CMake Website
  • Required for building the program
• pthread.h
  • Required for threading models
  • Available on most Unix platforms

---

Building

Protium prohibits building within the directory tree. Therefore the following definitions will be made:

• <source_directory>
  • Where the source is located
• <build_directory>
  • Where the build will be located
  • It's advised that for naming conventions, that this be similar to the source directory

In order to generate build files for the program, issue the following command(s):

cd <build_directory>
cmake <source_directory>

Or, to use the graphical editor:

cd <build_directory>
ccmake <source_directory>

If configuring cmake and generating build files

Unix-Like Systems

This includes MacOSX (Darwin). The commands to issue at this point are:

make
make install

Make sure to set LD_LIBRARY_PATH or, on Darwin, DYLD_LIBRARY_PATH to the location of the libraries. This will be automated in the future.

Windows

Warning

There are no plans to make Protium Windows-compatable.

---

Running

Protium will include unit tests

<name of exec> <optional path to macro>

The source code for the main executables is found in the Applications/ folder

---

Code Hierarchy

Protium is designed to be a VERY modular library. Every module will have a header for the full library located in the directory.

Note

Example:

#include <Protium/LinearAlgebra/LinearAlgebra.h>

All headers are included in the top-down file, Protium.h .

The following modules are part of the Protium libraries

• Design
  • Provides design technologies. Specifically, assertions, dimensionful quantities and types
  • Dependencies:
    • None
• Threads
  • Provides threading technologies
  • Explicit Dependencies:
    • Design
• Singleton
  • Defines singleton utilities such as creation and deletion policies
  • Explicit Dependencies:
    • Threads
    • Design
• Utilites
  • Miscellanious utility functions
  • Explicit Dependencies:
    • Singleton
• Allocation
  • Provides base classes for small object allocation
  • Explicit Dependencies:
    • Threads
    • Design
    • Singleton
• Linear Algebra
  • Provides matrix and vector classes to perform linear algebra
  • Explicit Dependencies:
    • Allocation
• Containers
  • Provides histogram and function classes for data storage
  • Explicit Dependencies:
    • Allocation

---

Contact

Please contact Kevin Wierman at kwier.nosp@m.man@.nosp@m.gmail.nosp@m..com with issues, flaws or questions