Foam-Agent
Foam-Agent: An end-to-end, composable multi-agent framework for automating CFD simulations in OpenFOAM. NeurIPS 2025 Machine Learning and the Physical Sciences Workshop.
File Explorer
Download Latest Version (.zip)- foam.md
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- index.faiss
- index.pkl
- .gitkeep
- foamgpt_data.py
- foamgpt_gen.py
- foamgpt_huggingface.py
- foamgpt_openai.py
- foamgpt_parser.py
- openfoam_allrun_scripts.txt
- openfoam_case_stats.json
- openfoam_command_help.txt
- openfoam_commands.txt
- openfoam_tutorials_details.txt
- openfoam_tutorials_structure.txt
- faiss_allrun_scripts.py
- faiss_command_help.py
- faiss_tutorials_details.py
- faiss_tutorials_structure.py
- tutorial_parser.py
- Dockerfile
- foamagent-entrypoint.sh
- .gitkeep
- extract_v10_case.py
- mock_sbatch.sh
- run_esi_docker_verify.sh
- verify_esi_translation.py
- cli.py
- fastmcp_server.py
- README.md
- start_mcp.py
- __init__.py
- hpc_runner_node.py
- input_writer_node.py
- local_runner_node.py
- meshing_node.py
- planner_node.py
- reviewer_node.py
- visualization_node.py
- __init__.py
- input_writer.py
- mesh.py
- plan.py
- review.py
- run_hpc.py
- run_local.py
- visualization.py
- __init__.py
- esi_translation_rules.json
- esi_translator.py
- __init__.py
- codex_instructions_default.txt
- config.py
- logger.py
- main.py
- models.py
- router_func.py
- tracking_aws.py
- utils.py
- test_esi_translator.py
- test_lid_driven_cavity_mcp.py
- test_lid_driven_cavity_services.py
- .dockerignore
- .gitattributes
- .gitignore
- AGENTS.md
- app.py
- environment.yml
- foambench_main.py
- init_database.py
- LICENSE
- overview.png
- PR_DESCRIPTION.md
- pyproject.toml
- README.md
- tandem_wing.msh
- user_req_tandem_wing.txt
- user_requirement.txt
- wechat_foamagent.JPG
# Installation Guide
1. Get the code
git clone https://github.com/csml-rpi/Foam-Agent
Downloads the entire project code from GitHub to your computer.
cd Foam-Agent
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -it \
Runs the built image as an actual container.
docker build -f docker/Dockerfile -t foamagent:latest .
Builds a runnable image based on the Dockerfile.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install -e .
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)