👋Welcome to aPriori
A Python package to process combustion DNS.
Disclaimer: The guide is not complete yet. Please contact me at [email protected] 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 Getting Started 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 Fundamentals and Usage 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 Library Structure 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.