Light mode version
Dark mode version

GPL v3.0 License GitHub Source Code Documentation GitHub Issues PyPI Downloads Zenodo DOI

πŸ‘‹ Welcome to aPrioriΒΆ

A Python package to process Direct Numerical Simulations (DNS) of reacting and non-reacting flows.

OverviewΒΆ

This documentation is meant to help you:

  • understand the purpose and scope of the project,

  • get the library installed and run your first example,

  • learn the core concepts and usage patterns,

  • explore the full API reference when you need more detail.

The documentation is organised in three main parts:

  • Getting Started – introduction to the project, installation instructions, and a quickstart example that you can run immediately.

  • Fundamentals & Usage – more in-depth material on the main classes and workflows, with examples of how to build analyses step by step.

  • API Guide – automatically generated reference for modules, classes and functions. This is mostly useful when you already know the basics and need precise details.