List libmesh dependencies in README.md

[libmesh]

List libmesh dependencies in README.md

[benkirk]

On Jan 28, 2013, at 1:43 PM, Damon McDougall [email protected] wrote:

On trying to compile and install libmesh from source, I noticed that the library's dependencies are not listed in the README.md file.

Specifically, what failed?

I'm not sure how to treat this -- there should really be no required dependences except for a C++ compiler. Everything else should be defeatable via configure arguments.

[roystgnr]

I noticed that the library's dependencies are not listed in the
README.md file.

What's the protocol on that? The definition of "dependency" gets
fluid when you can compile with or without various options. Although
there are a lot of third-party packages that greatly improve libMesh
functionality, anyone ought to be able to get small problems running
with nothing more than a C++2003 compiler and the stuff we distribute
in contrib/.

[pbauman]

On Mon, Jan 28, 2013 at 1:46 PM, Benjamin S. Kirk
[email protected]:

Specifically, what failed?

I'm not sure how to treat this -- there should really be no required
dependences except for a C++ compiler. Everything else should be
defeatable via configure arguments.

Probably still worthwhile to at least put in what is supported?

[dmcdougall]

@roystgnr There may or may not be a protocol. I'm trying to get it listed in module avail on sl6. I presume I need to load the dependencies to get it to appear.

$ module list
Currently Loaded Modules:
  1) sl6      3) mpich2/1.4.1p1  5) autotools/1.1  7) boost/1.51.0  9) hdf5/1.8.9    11) mkl/gf-10.2.6.038  13) petsc/3.3-p2-cxx-opt
  2) gcc/4.6  4) distcc/3.2rc1   6) glpk/4.47      8) gsl/1.15      10) grvy/0.32.0  12) texlive/2012     
$ module spider libmesh
Rebuilding cache file, please wait ... done
Unable to find: "libmesh"

[dmcdougall]

Specifically, what failed?

I'm not sure how to treat this -- there should really be no required dependences except for a C++ compiler. Everything else should be defeatable via configure arguments.

Sorry, I guess I'm asking a very narrow question on the setup at ICES. It appears as though you don't actually need anything to make it compile.

[roystgnr]

Yeah, you'll want to load mkl, mpich2, petsc, trilinos, tbb, and vtk -
none of those are required for libMesh, though, it's just my kitchen
sink configuration.

So the actual bug here is a failure of our "module spider" command,
but I do think listing various optional dependencies in our README
would be useful. Now... what's the difference between README and
README.md?

[dmcdougall]

Yeah, you'll want to load mkl, mpich2, petsc, trilinos, tbb, and vtk -
none of those are required for libMesh, though, it's just my kitchen
sink configuration.

So the actual bug here is a failure of our "module spider" command,
but I do think listing various optional dependencies in our README
would be useful

Yeah, I'm not sure why I thought this was an appropriate place to open this issue. Apologies.

Now... what's the difference between README and
README.md?

I'm not sure what you mean. The content shouldn't be any different. *.md files just contain extra foo so that whatever viewer you are using can format it nicely.

[benkirk]

Now... what's the difference between README and
README.md?

I'm not sure what you mean. The content shouldn't be any different. *.md files just contain extra foo so that whatever viewer you are using can format it nicely.

Right. John created README.md from README and put in some spice.

We could remove README altogether except automake likes it if you are enforcing GNU coding standards. So maybe the right thing to do is have bootstrap copy README.md to README…

-Ben