Updated Build Guide #1332
Updated Build Guide #1332
Conversation
| axom_ 0.3.1 *mandatory* :code:`AXOM_DIR` | ||
| Adiak_ 0.2.0 :code:`ENABLE_CALIPER` :code:`ADIAK_DIR` | ||
| Caliper_ 2.4.0 :code:`ENABLE_CALIPER` :code:`CALIPER_DIR` | ||
| conduit_ 0.5.0 *mandatory* :code:`CONDUIT_DIR` | ||
| CHAI_ 2.2.2 *mandatory* :code:`CHAI_DIR` | ||
| RAJA_ 0.12.1 *mandatory* :code:`RAJA_DIR` | ||
| hdf5_ 1.10.5 *mandatory* :code:`HDF5_DIR` | ||
| mathpresso_ 2015-12-15 :code:`ENABLE_MATHPRESSO` :code:`MATHPRESSO_DIR` | ||
| pugixml_ 1.8.0 *mandatory* :code:`PUGIXML_DIR` | ||
| parmetis_ 4.0.3 *mandatory* (with MPI) :code:`PARMETIS_DIR` built with 64-bit :code:`idx_t` | ||
| suitesparse_ 5.8.1 :code:`ENABLE_SUITESPARSE` :code:`SUITESPARSE_DIR` | ||
| superlu_dist_ 0f6efc3 :code:`ENABLE_SUPERLU_DIST` :code:`SUPERLU_DIST_DIR` | ||
| hypre_ 2186a8f :code:`ENABLE_HYPRE` :code:`HYPRE_DIR` | ||
| PETSc_ 3.13.0 :code:`ENABLE_PETSC` :code:`PETSC_DIR` | ||
| Trilinos_ 12.18.1 :code:`ENABLE_TRILINOS` :code:`TRILINOS_DIR` | ||
| silo_ 4.10.3 *mandatory* :code:`SILO_DIR` | ||
| VTK_ 9.0.0-rc3 :code:`ENABLE_VTK` :code:`VTK_DIR` only a small subset of modules required | ||
| doxygen_ 1.8.20 :code:`ENABLE_DOXYGEN` :code:`DOXYGEN_EXECUTABLE` | ||
| sphinx_ 1.8.20 :code:`ENABLE_SPHINX` :code:`SPHINX_EXECUTABLE` | ||
| uncrustify_ 401a409 :code:`ENABLE_UNCRUSTIFY` :code:`UNCRUSTIFY_EXECUTABLE` |
There was a problem hiding this comment.
I'm afraid the versions will never be maintained.
There was a problem hiding this comment.
Yeah... unless we're super vigilant on all and any thirdPartyLibs PRs. I just thought, since there is a way for users to provide dependencies separately (without thirdPartyLibs), it'd be good to have required versions listed in the documentation. I see no problem removing it though.
| uncrustify_ 401a409 :code:`ENABLE_UNCRUSTIFY` :code:`UNCRUSTIFY_EXECUTABLE` | ||
| ============= ========== =========================== ============================= ======================================== | ||
|
|
||
| .. _axom : https://github.com/LLNL/axom |
There was a problem hiding this comment.
What will be the display? Will we have the links below the table? Embedded?
And you remove the small description. Don't you think it could be useful for someone discovering a new toolbox?
There was a problem hiding this comment.
In generated HTML the links are displayed only inside table cells, same way as a normal embedded link would (e.g. `axom <https://github.com/LLNL/axom>\`_), but this allows me to make table cells smaller in raw rst. I.e. there is no separate list following the table: https://docutils.sourceforge.io/docs/user/rst/quickref.html#hyperlink-targets
I omitted the descriptions mainly because they didn't fit in the table well. I think I can find a way to bring them back though.
| @@ -0,0 +1,70 @@ | |||
| Building GEOSX | |||
There was a problem hiding this comment.
A space in the filename Building GEOSX.rst?
Someone shall have problems someday.
There was a problem hiding this comment.
There was another file that did this and I sort of followed suit on autopilot. I will fix both just to be safe.
| GEOSX makes use of multiple third-party libraries (TPLs) and tools, some of which are mandatory and some optional. | ||
| We only test against specific versions, and sometimes even require development snapshots (specific git commits). | ||
| Not all of these guarantee backwards compatibility, so we strongly recommend building with these specific versions. |
There was a problem hiding this comment.
Maybe reference Prerequisites?
klevzoff
force-pushed
the
docs/klevzoff/build-guide
branch
from
3691c11 to
f87ad01
Compare
Please add branch on RTD if you need for review.