Documentation updates: touch up BUILD.md, add Spack.md #3187
Conversation
jjwilke
commented
Jul 15, 2020
jjwilke
commented
- Adds some extra details based on user feedback in the build documentation
- Fixes some missing/incorrect options in the BUILD.md
- Moves the README from kokkos-spack into kokkos since kokkos-space will no longer be maintained
Spack.md
Outdated
| We can verify we have `+volta70` and `+wrapper`, e.g. | ||
|
|
||
| ### Spack Environments | ||
| The encouraged method of using Spack is to use environments. |
There was a problem hiding this comment.
That sentence sound weird to me.
jjwilke
force-pushed
the
doc-updates
branch
3 times, most recently
from
99e6091
to
c82e505
Compare
| ````cmake | ||
| cmake_policy(SET CMP0074 NEW) | ||
| ```` | ||
| If building in-tree, there is no `find_package`. You can use `add_subdirectory(kokkos)` with the Kokkos source and again just link with `target_link_libraries(Kokkos::kokkos)`. |
There was a problem hiding this comment.
I would mention examples/cmake_build_installed and examples/cmake_build_in_tree here as examples.
There was a problem hiding this comment.
Added. I had to clean up these examples as well (redundant with another PR, but we should fix the comments in these examples ASAP).
Spack.md
Outdated
| kokkos: | ||
| variants: +hip amd_gpu_arch=vega900 | ||
| ```` | ||
| Note: there is currently no support for the `hipcc` compiler in Spack. Spack currently does not have rules for building the compiler nor can an already installe version be added to Spack as a valid compiler. |
There was a problem hiding this comment.
| Note: there is currently no support for the `hipcc` compiler in Spack. Spack currently does not have rules for building the compiler nor can an already installe version be added to Spack as a valid compiler. | |
| Note: there is currently no support for the `hipcc` compiler in Spack. Spack currently does not have rules for building the compiler nor can an already installed version be added to Spack as a valid compiler. |
That's not entirely true. You could trick Spack into thinking that hipcc is a clang compiler. That's what I did when testing the spack module. I am not sure if we want to mention any of this at all.
There was a problem hiding this comment.
I just took out that language for now. It's probably not even worth mentioning since hipcc is an advanced use case at this point.
| ### Spack Environments | ||
| The encouraged way to use Spack is with Spack environments. | ||
| Rather than installing packages one-at-a-time, you add packages to an environment. | ||
| After adding all packages, you concretize and install them all. |
There was a problem hiding this comment.
| Make sure you have downloaded [Spack](https://github.com/spack/spack) and added it to your path. | ||
| The easiest way to do this is often (depending on your SHELL): | ||
| ````bash | ||
| > source spack/share/spack/setup-env.sh |
There was a problem hiding this comment.
I think spack will complain if you don't also set SPACK_ROOT in your environment variables
There was a problem hiding this comment.
Reworded to make this clearer. Thanks for pointing this out.
jjwilke
force-pushed
the
doc-updates
branch
2 times, most recently
from
d16bb17
to
180aebf
Compare
|
I'm adding BLOCKS PROMOTION to this. We should really fix these docs before next release. |
|
Since we changed |
| add_subdirectory(${Example_SOURCE_DIR}/../.. ${Example_BINARY_DIR}/kokkos) | ||
|
|
||
| add_executable(example cmake_example.cpp) | ||
| add_executable(example cmake_example.cpp foo.f) |
There was a problem hiding this comment.
| add_executable(example cmake_example.cpp foo.f) | |
| add_executable(example cmake_example.cpp) |
We don't use Fortran here anymore.
