Copy of aPriori Documentation
  • 👋Welcome to aPriori
  • Getting started
    • What is aPriori?
    • Installation
    • Quickstart
  • Fundamentals and usage
    • aPriori Fundamentals
      • Data Formatting
      • Using Scalar3D class
      • Using Mesh3D class
      • Using Field3D class
      • Plot Utilities
    • Tutorial
      • Data-Driven Closure for Turbulence-Chemistry interaction
  • API guide
    • Scalar3D class
    • Mesh3D Class
    • Field3D class
Powered by GitBook
On this page
  • Overview
  • Getting Started
  • Fundamentals and Usage
  • API Guide

Welcome to aPriori

A Python package to process combustion DNS.

NextWhat is aPriori?

Disclaimer: The guide is not complete yet. Please contact me at lorenzo.piu@ulb.be in case you need anything. In the meantime, I am working to complete the documentation.

Overview

This guide explains how to use the library and the main features.

The first section introduces the scope of the project, explains how to install the package in your environment and gives a code that can be used immediately to perform analysis on a DNS of a hydrogen flame. The second section goes into more detail, giving examples of how to use the single blocks of the library to obtain the maximum from it. If you didn't understand much from the code in the quickstart, this section is the right one to get more insight. The third section covers more in detail the code from a developer's point of view, explaining the single functions and the main classes with their attributes and methods. If you are interested in the library from the point of view of a user, you can skip this section.


Getting Started

Fundamentals and Usage

API Guide

Getting Started
Fundamentals and Usage
Library Structure
What is aPriori?
Installation
Quickstart
aPriori Fundamentals
Data Formatting
Using Scalar3D class
Using Mesh3D class
Using Field3D class
Plot Utilities
Tutorial
Data-Driven Closure for Turbulence-Chemistry Interaction
Scalar3D class
Mesh3D class
Field3D class
👋
Page cover image