diff --git a/README.md b/README.md index eafbd4e1..542f5b0e 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,53 @@ --- +# Table of Contents +- [Introduction](#introduction) + - [Design Philosophy and Workflow](#design-philosophy-and-workflow) + - [Funding](#funding) +- [Usage](#usage) + - [Python installation](#python-installation) + - [pypi](#pypi) + - [source](#source) + - [source for developers](#source-for-developers) + - [Automatic Build and Installation](#automatic-build-and-installation) + - [Script Build and Installation Instructions](#script-build-and-installation-instructions) + - [Currently, known good platforms](#currently-known-good-platforms) + - [Manual Build Instructions](#manual-build-instructions) + - [Prerequisites](#prerequisites) + - [Install Scripts](#install-scripts) + - [Dependency Installation on Common Platforms](#dependency-installation-on-common-platforms) + - [Building the C++ Library](#building-the-c-library) + - [Installing the Library](#installing-the-library) + - [Minimum compiler versions](#minimum-compiler-versions) +- [Code Architecture and Logical Flow](#code-architecture-and-logical-flow) +- [Engines](#engines) + - [GraphEngine](#graphengine) + - [GraphEngine Configuration Options](#graphengine-configuration-options) + - [Available Partition Functions](#available-partition-functions) + - [AutoDiff](#autodiff) +- [Reaclib in GridFire](#reaclib-in-gridfire) +- [Engine Views](#engine-views) + - [A Note about composability](#a-note-about-composability) +- [Numerical Solver Strategies](#numerical-solver-strategies) + - [NetworkSolverStrategy<EngineT>](#networksolverstrategyenginet) + - [NetIn and NetOut](#netin-and-netout) + - [DirectNetworkSolver (Implicit Rosenbrock Method)](#directnetworksolver-implicit-rosenbrock-method) + - [Algorithmic Workflow in DirectNetworkSolver](#algorithmic-workflow-in-directnetworksolver) + - [Future Solver Implementations](#future-solver-implementations) +- [Python Extensibility](#python-extensibility) +- [Usage Examples](#usage-examples) + - [C++](#c) + - [GraphEngine Initialization](#graphengine-initialization) + - [Adaptive Network View](#adaptive-network-view) + - [Composition Initialization](#composition-initialization) + - [Common Workflow Example](#common-workflow-example) + - [Callback Example](#callback-example) + - [Python](#python) + - [Common Workflow Example](#common-workflow-example-1) + - [Python callbacks](#python-callbacks) +- [Related Projects](#related-projects) + # Introduction GridFire is a C++ library designed to perform general nuclear network evolution. It is part of the larger SERiF project within the 4D-STAR