search

charmplusplus / charm

The Charm++ parallel programming system. Visit https://charmplusplus.org/ for more information.
Apache License 2.0
206 stars 50 forks source link

Fully document installation options #2926

Open RossBoylan opened 4 years ago

RossBoylan commented 4 years ago

https://charm.readthedocs.io/en/latest/quickstart.html#installing-charm says, at the end of section 1.1

For advanced compilation options, please see Section 2.6.1 of the manual.

That section, in turn, says

Details on all the available alternatives for each of the above mentioned parameters can be found by invoking ./build --help.

And, when I try that, after installing CMake after getting the latest from github ( e4a6e7b3f1ae0b):

$ ./build --help
Usage: ./buildcmake <target> <triplet> [other options]
  See the Charm++ manual at
  https://charm.rtfd.io/en/latest/charm++/manual.html#installing-charm
  for full instructions.

At which point we have a circular dependency!

And I am none the wiser about either what the complete set of options are, or of what they mean. By "options" I include the actual meaning of the triplets. I don't even know if I have to choose between shared memory and networked communication, or if charm can use both, as appropriate.

matthiasdiener commented 4 years ago

Thanks for the report @RossBoylan! I've prepared a patch that restores --help in the cmake build system: #2927.

Regarding the meaning of the triplets, I think the most comprehensive documentation is in our README file: https://github.com/UIUC-PPL/charm/blob/master/README.md . In particular, you can combine shared memory and networked communication with the smp option.