Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance template read me #87

Merged
merged 12 commits into from
Feb 3, 2025
Merged

Conversation

Toddelismyname
Copy link
Contributor

@Toddelismyname Toddelismyname commented Feb 2, 2025

  • More help
  • Some dynamically generated sections for example solvers and participants get listed based on topology or links to solvers as help are also dynamically gotten.

New output looks like this:

🚀 Multiphysics Simulation Project

This README.md file was auto-generated by the FileGenerator.py script, providing a comprehensive guide to your coupled simulation.


📋 Project Overview

This project utilizes preCICE (Precise Code Interaction Coupling Environment) for a multiphysics simulation involving:

  • Participants:

    • Fluid
    • Solid
  • Solvers:

    • SU2
    • Calculix
  • Coupling Strategy:
    Partitioned


🛠 Prerequisites

Before running the simulation, ensure you have the following installed:

  • preCICE library
  • SU2 solver
  • Calculix solver
  • Required dependencies for each solver

🏃‍♂️ Running the Simulation

Quick Start

# Navigate to the `_generated` folder
cd _generated/

# Make the run script executable
chmod +x run.sh

# Execute the simulation
./run.sh

Advanced Execution

For more control or debugging:

  • Check run.sh for specific command-line arguments
  • Modify solver-specific parameters in adapter-config.json

🔍 Simulation Configuration

  • preCICE Configuration: precice-config.xml
    • Defines coupling interface and communication strategy
    • Modify with caution, refer to preCICE documentation

Adapter Configurations:

  • Fluid: Fluid-SU2/adapter-config.json
  • Solid: Solid-Calculix/adapter-config.json
    • Solver-specific coupling parameters
    • Adjust solver input/output mappings here

🧹 Cleaning Simulation Artifacts

# Make the clean script executable
chmod +x clean.sh

# Remove generated files and reset workspace
./clean.sh

Warning: This will remove all generated files except preserved ones.


📚 Additional Resources


🤝 Troubleshooting

Common issues and solutions:

  • Ensure all solvers are compatible with preCICE version
  • Check network/communication settings
  • Verify adapter configuration mappings

For specific problems, consult:

  • Solver documentation
  • preCICE community forums
  • Project-specific documentation

Generated by FileGenerator.py - Simplifying Multiphysics Simulation Workflows

@Toddelismyname Toddelismyname added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 2, 2025
@Toddelismyname Toddelismyname self-assigned this Feb 2, 2025
@Toddelismyname
Copy link
Contributor Author

Still needs some finishing touches but more helpful than the one before or with more information in general. What do you think ? @VanLaareN
For reference the output before was:

🚀 Simulation README

This README.md file was auto-generated by the FileGenerator.py script.


🏃‍♂️ Running the Simulation

To run the simulation:

  1. Navigate to the _generated folder.
  2. Execute the following command:
bash run.sh

or

chmod +x run.sh
./run.sh

🧹 Cleaning the artifacts of the Simulation

To clean up:

  1. Navigate to the _generated folder.
  2. Execute the following command:
bash clean.sh

or

chmod +x clean.sh
./clean.sh

📚 Learning Materials

Want to dive deeper into preCICE? Check out the official tutorials:

🔗 preCICE Tutorials


🤝 Contributions

We welcome contributions! To contribute to this project:

👉 Visit our repository: preCICE GitHub Repo

@VanLaareN VanLaareN merged commit de9e239 into main Feb 3, 2025
1 check passed
@VanLaareN VanLaareN deleted the work/toddel/enhance-template-ReadMe branch February 3, 2025 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants