Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
taehyounpark committed Nov 11, 2023
1 parent d554508 commit b9b8ab4
Show file tree
Hide file tree
Showing 14 changed files with 318 additions and 3,013 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
***Ana**lysis **Logic** **A**bstraction **L**ayer*
_**Ana**lysis **Logic** **A**bstraction **L**ayer_

![Version](https://img.shields.io/badge/Version-0.2.0-blue.svg)
[![Ubuntu](https://github.com/taehyounpark/analogical/actions/workflows/ubuntu.yml/badge.svg?branch=master)](https://github.com/taehyounpark/analogical/actions/workflows/ubuntu.yml)
[![macOS](https://github.com/taehyounpark/analogical/actions/workflows/macos.yml/badge.svg?branch=master)](https://github.com/taehyounpark/analogical/actions/workflows/macos.yml)
[![Documentation](https://img.shields.io/badge/mkdocs-Documentation-blue.svg)](https://opensource.org/licenses/MIT)
[![Documentation](https://img.shields.io/badge/Documentation-mkdocs-blue.svg)](https://taehyounpark.github.io/analogical/home/design/)
[![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`analogical` is a C++ library for performing dataset transformations.

<p align="center">
<strong> <a href="https://marzer.github.io/tomlplusplus/">See full documentation</a></strong>
</p>

## Features

`analogical` is a C++ dataset transformation library.
## Features

- "Dataflow" interface.
- *Dataflow* interface.
- Lazy execution.
- Multithreaded processing.
- Sensitivity analysis.

## Design goals

- **Clear interface.** Specify operations with a clear, high-level abstraction interface using modern C++ syntax.
- **Customizable plugins.** Operations with arbitrary inputs, execution, and outputs receive first-class treatment: from custom datasets and columns to complex aggregations, there is a customizable ABC.
- **Sensitivity analysis.** With built-in handling of systematic variations, changes to an operation are automatically propagated and all results under the original and varied scenarios are obtained simultaneously.
- **Computational efficiency.** Dataset operations are (1) multithreaded, and (2) performed for an entry only if needed.

## Documentation

***<p style="text-align: center;">[The documentation is under construction](https://taehyounpark.github.io/analogical/)</p>***

- **Clear interface.** Use a clear high-level abstraction layer with modern C++ syntax to specify even the most complex operations.
- **Customizable operations.** Support for inputs and outputs of any type and arbitrary execution, such as custom dataset formats, column definitions, and aggregation algorithms.
- **Sensitivity analysis.** Systematic variations of an analysis are automatically propagated and simultaneously processed within one dataset traversal.
- **Computational efficiency.** Dataset operations are performed for an entry only if needed. Dataset traversal is multithreaded.

## Installation

Expand Down
Loading

0 comments on commit b9b8ab4

Please sign in to comment.