Update docker container, add Docker auto-build and test, update documentation for building with spack-stack

mkavulich commented 5 months ago

This PR has several updates that improve SCM documentation, overhaul the docker container, updates new and existing tests, and adds modulefiles for building on MacOS and generic Linux.

Documentation

Documentation for this branch is built here: https://ccpp-scm-mkavulich.readthedocs.io/en/feature-macos_and_docker_build/

This update adds some information about testing to the Repository chapter (though more details should probably be included), and completely overhauls the Quick Start chapter.

Among the changes to the Quick Start chapter are:

Removing some less relevant text, and rearranging and updating some wording to improve flow of the chapter (this is supposed to be a "quick" start after all)
Replace non-standard section delimiters per Sphinx documentation
Include more information about spack-stack, including more links
Include instructions for loading environment on pre-configured platforms, as well as other procedures for building spack-stack or setting environment variables manually on other platforms such as MacOS and Linux
Update Python section for appropriate prerequisites
Use Sphinx built-in Notes markup to highlight important points
Update run commands, add more examples
Update Docker section with relevant changes (see next section)

Docker

The Dockerfile is updated to work with the latest CCPP code. The old "common community container" is no longer used, as it is no longer supported.
A github action is introduce that runs on each commit to main. This action will build the container and push it to Dockerhub under the tag "dtcenter/ccpp-scm:latest". This will ensure there is always an up-to-date, working container for the top of the main branch.

Testing

A new CI test will build and run the regressiont tests with the Docker container when a new pull request is created
Test ci_build_scm_ubuntu_22.04_nvidia.yml is modified to only run on pull_requests and when manually requested

Other

Add new "generic platform" modulefiles macos_clang and linux_gnu for use with spack-stack installations.

This PR will resolve #409 and partially resolve #455 (will still need a release container when the time comes)

mkavulich commented 5 months ago

Note: the new job to auto-push the latest container to Dockerhub makes use of repository secrets: I have provided my dockerhub credentials as DOCKERHUB_USERNAME and DOCKERHUB_TOKEN since I can write to the dtcenter organization on Dockerhub. If in the future I am not around, or if I lose access to that Dockerhub org, those secrets will have to be updated.

mkavulich commented 4 months ago

@grantfirl Did you want a chance to review this or can I go ahead and merge it?

grantfirl commented 4 months ago

@mkavulich Can you update to the latest main for good measure before I press the merge button?

mkavulich commented 4 months ago

@grantfirl Rebased my branch on the latest main

NCAR / ccpp-scm