sphericart icon indicating copy to clipboard operation
sphericart copied to clipboard

Improvements to installation docs

Open sirmarcel opened this issue 1 year ago • 3 comments

Hi there, I've just gone through the process of installing sphericart with CUDA for the first time and I'd suggest some minor improvements to the related docs:

  • Mention that the target GPU needs to be available during installation (relevant on HPC, where the login node may not have one)
  • Mention that some fairly serious amount of RAM is required (see #115)

Additionally, the docs on building the C++ code could benefit from:

  • Mention that libtorch is a requirement and where it should be exported (CMAKE_PREFIX_PATH)
  • Mention the need for cmake to be at least version 3.24 (otherwise the detection of which target GPU to target fails)

Overall, it'd be a good idea to make it possible to build for non-present GPUs, but this can't be accomplished by slightly polishing the docs. :)

sirmarcel avatar Apr 29 '24 17:04 sirmarcel

Hello,

Many thanks for reporting this and providing your observations.

It's usually recommended to build software on the compute nodes, rather than the login nodes, at least this is what we recommend at CSCS. I will however investigate adding in a CMake variable where you can set the gencode and archcode manually, so you can choose that sphericart is built for a given architecture (or potentially a list of).

I'll create a PR tomorrow that addresses the above as well as the RAM issue (and modify the necessary documentation accordingly!)

rubber-duck-debug avatar Apr 29 '24 20:04 rubber-duck-debug

Thank you! Very impressed with the responsiveness here :)

sirmarcel avatar Apr 29 '24 21:04 sirmarcel

Hello! @nickjbrowning did this PR actually happen? Can we close this issue?

ceriottm avatar Aug 07 '24 06:08 ceriottm