SimVascular / simvascular.github.io-archive

SimVascular website
4 stars 11 forks source link

Documentation does not mention that you need to install svSolver #33

Open ktbolt opened 4 years ago

ktbolt commented 4 years ago

The Quick Guide Simulation section does not mention that you need to install svSolver to run a simulation.

The Simulation Guide section wrongly states

Notice: To get full functions from the Simulation tool, it uses three solvers: Presolver (svPre), Flowsolver (svSolver), Postsolver (svPost). Normally, SimVascular already includes the solvers and can find them automatically. Users don’t need to set up the solvers. However, in case SimVascular can’t find them while users are using the Simulation tool, refer to Solver Configuration.

There are not three solvers and they are not included in SV.

In the Simulation Guide/Configurating Solvers (Optional) section contradicts the above section and does hint that you may need to install svSolver.

SimVascular solvers(presolver, flowsolver, postsolver) are used as individual executable programs. They are called by SV Simulation tool to create data files, run simulation, and convert results to files in VTK formats. Normally those solvers are installed separately. However, SimVascular can automatically find those solvers. In case your SimVascular can’t find them, or you want to use different solvers, you need to explicitly tell SimVascular where to find or how to use them.

I will add a section (not optional) that states that svSolver needs to be installed and how to install it.