Add FastChem installation step to docs#662
Merged
timlichtenberg merged 1 commit intomainfrom Mar 24, 2026
Merged
Conversation
FastChem (equilibrium chemistry solver used by AGNI) was missing from the installation guide. Add it as step 9 after AGNI, with cmake/make prerequisites, build instructions, and FC_DIR environment variable setup. Renumber subsequent steps accordingly.
timlichtenberg
requested review from
IKisvardai,
Copilot,
ipanagiotou02 and
nichollsh
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the developer installation guide to include FastChem (required by AGNI for equilibrium chemistry) as an explicit, standard install step so new developer setups don’t miss this dependency.
Changes:
- Adds a new “Install FastChem” step with prerequisites (
cmake,make), build command, andFC_DIRenvironment variable setup for bash/zsh. - Renumbers subsequent developer installation steps to accommodate the new step.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #662 +/- ##
==========================================
+ Coverage 69.12% 69.15% +0.02%
==========================================
Files 98 98
Lines 10123 10123
Branches 1401 1401
==========================================
+ Hits 6998 7001 +3
+ Misses 2791 2788 -3
Partials 334 334
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
nichollsh
approved these changes
Mar 24, 2026
Member
nichollsh
left a comment
nichollsh
left a comment
There was a problem hiding this comment.
Looks good! Are we missing any other critical installation steps?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add
get_fastchem.shas a standard installation step (step 9) in the developer installation guide. FastChem is used by AGNI for equilibrium chemistry calculations and was previously missing from the docs.Changes:
FC_DIRenvironment variable setup (bash/zsh tabs)Tested locally on macOS (Intel, Sequoia) and confirmed FastChem compiles successfully.
Validation of changes
Ran
bash src/get_fastchem.shinside the AGNI directory on macOS. Build completed successfully, binary produced at expected path. Served docs locally withzensical serveand verified rendering.Test configuration: macOS Sequoia (Intel) with cmake 4.3.0, AppleClang 17.0.0.
Checklist
Relevant people
@nichollsh @ipanagiotou02 @IKisvardai