Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #804

Merged
merged 4 commits into from
Oct 3, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 26 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,32 @@
![spack-stack-logo](https://user-images.githubusercontent.com/8006981/234488735-45b2c5fa-1de6-47ad-ae3b-4a6829ae49b9.png)

Spack-stack enables the installation of software required
for HPC system deployments of NOAA's Unified Forecast System (UFS) and
other weather and climate models, including components of the Joint
Effort for Data assimilation Integration (JEDI).

Spack-stack is a collaborative effort between:
* [NOAA Environmental Modeling Center (EMC)](https://www.emc.ncep.noaa.gov/emc_new.php)
* [UCAR Joint Center for Satellite Data Assimilation (JCSDA)](https://www.jcsda.org/)
* [Earth Prediction Innovation Center (EPIC)](https://epic.noaa.gov/).

Spack-stack is a thin layer around a fork of the
[spack](https://github.com/spack/spack) repository. Spack is a
community-supported, multi-platform, Python-based package manager
originally developed by the Lawrence Livermore National Laboratory
<img src="https://user-images.githubusercontent.com/8006981/234488735-45b2c5fa-1de6-47ad-ae3b-4a6829ae49b9.png" width="425">

Spack-stack is a framework for installing software libraries to support
NOAA's Unified Forecast System (UFS) applications and the
Joint Effort for Data assimilation Integration (JEDI) coupled to
several Earth system prediction models (MPAS, NEPTUNE, UM, GEOS).

AlexanderRichert-NOAA marked this conversation as resolved.
Show resolved Hide resolved
Spack-stack supports installations on a range of R&D and operational platforms.
It provides a set of installation templates (package lists), default package settings,
system configurations for a range of [macOS and Linux workstation, HPC, and cloud
platforms](https://spack-stack.readthedocs.io/en/latest/PreConfiguredSites.html), and Spack extensions, and uses a fork of the
[Spack repository](https://github.com/spack/spack). [Spack](https://spack.io/) is a
community-supported, multi-platform package manager
developed by Lawrence Livermore National Laboratory
(LLNL). Spack is provided as a submodule to spack-stack so that a
stable version can be referenced. For more information about spack see
the [LLNL project page for
spack](https://computing.llnl.gov/projects/spack-hpc-package-manager)
and the [spack
documentation](https://spack.readthedocs.io/en/latest/).

The stack can be installed on a range of platforms, from Linux and
macOS laptops to HPC systems, and comes pre-configured for many
systems. Users can install the necessary packages for a particular
application and later add the missing packages for another application
without having to rebuild the entire stack.
stable version can be referenced. For more information about Spack, see
the [LLNL project page for Spack](https://computing.llnl.gov/projects/spack-hpc-package-manager)
and the [Spack documentation](https://spack.readthedocs.io/en/latest/).

spack-stack is mainly a collection of Spack configuration files, but
provides a Spack extension to simplify the installation process:
**To get started with spack-stack**, either by using an existing
installation on a [supported platform](https://spack-stack.readthedocs.io/en/latest/PreConfiguredSites.html)
or by [creating a new installation](https://spack-stack.readthedocs.io/en/latest/CreatingEnvironments.html), see the
[Getting Started](https://spack-stack.readthedocs.io/en/latest/Overview.html#getting-started) documentation page.
Full documentation with table of contents can be found at https://spack-stack.readthedocs.io/en/latest/.

- `spack stack create` is provided to copy common, site-specific, and
application-specific configuration files into a coherent Spack
environment and to create container recipes

- `spack stack setup-meta-modules` creates compiler, MPI and Python
meta-modules for a convenient setup of a user environment using
modules (lua and tcl)

Documentation for installing and using spack-stack can be found here:
https://spack-stack.readthedocs.io/en/latest/

spack-stack is maintained by:

- NOAA-EMC: [Alex Richert](https://www.github.com/AlexanderRichert-NOAA), [Hang
Lei](https://www.github.com/Hang-Lei-NOAA), [Ed
Hartnett](https://www.github.com/edwardhartnett)
- JCSDA: [Dom Heinzeller](https://www.github.com/climbfuji), [Steve Herbener](https://github.com/srherbener)
- EPIC: [Cam Book](https://github.com/ulmononian), [Natalie Perlin](https://github.com/natalie-perlin)
Spack-stack is a collaborative effort between:
* [NOAA Environmental Modeling Center (EMC)](https://www.emc.ncep.noaa.gov/emc_new.php): [Alex Richert](https://www.github.com/AlexanderRichert-NOAA), [Hang Lei](https://www.github.com/Hang-Lei-NOAA), [Ed Hartnett](https://www.github.com/edwardhartnett)
* [UCAR Joint Center for Satellite Data Assimilation (JCSDA)](https://www.jcsda.org/): [Dom Heinzeller](https://www.github.com/climbfuji), [Steve Herbener](https://github.com/srherbener)
* [Earth Prediction Innovation Center (EPIC)](https://epic.noaa.gov/): [Cam Book](https://github.com/ulmononian), [Natalie Perlin](https://github.com/natalie-perlin)

For more information about the organization of the spack-stack
project, see the [Project Charter](project_charter.md).
Loading