Warning, /containers/docs/README.md is written in an unsupported language. File is not indexed.
0001 # EIC Container Infrastructure
0002
0003 Welcome to the EIC (Electron-Ion Collider) container infrastructure documentation. This documentation provides comprehensive information about the container build system, architecture, and instructions for building containers locally.
0004
0005 ## Overview
0006
0007 The EIC container infrastructure provides scientific software environments for the Electron-Ion Collider project. These containers are built using Docker/OCI standards and managed through GitHub Actions, with packages installed via the [Spack](https://spack.io/) package manager.
0008
0009 ## Quick Links
0010
0011 - [Architecture Overview](architecture.md) - Understanding the container build system
0012 - [Build Pipeline](build-pipeline.md) - GitHub Actions workflow details
0013 - [Building Locally](building-locally.md) - Instructions for local builds with caching
0014 - [Spack Environment](spack-environment.md) - Spack configuration and packages
0015
0016 ## Container Images
0017
0018 The infrastructure produces multi-architecture (amd64/arm64) container images:
0019
0020 | Image | Description | Registry |
0021 |-------|-------------|----------|
0022 | `debian_stable_base` | Base image with compilers and Spack | `ghcr.io/eic/debian_stable_base` |
0023 | `eic_ci` | CI environment (minimal packages) | `ghcr.io/eic/eic_ci` |
0024 | `eic_xl` | Full development environment | `ghcr.io/eic/eic_xl` |
0025
0026 ## Getting Started
0027
0028 For installation instructions of `eic-shell`, see the [eic-shell repository](https://github.com/eic/eic-shell).
0029
0030 ### Using the Container
0031
0032 ```bash
0033 # Pull the latest eic_xl image
0034 docker pull ghcr.io/eic/eic_xl:latest
0035
0036 # Run interactively
0037 docker run -it ghcr.io/eic/eic_xl:latest
0038
0039 # Or use Singularity/Apptainer
0040 singularity pull docker://ghcr.io/eic/eic_xl:latest
0041 singularity shell eic_xl_latest.sif
0042 ```
0043
0044 ## Repository Structure
0045
0046 ```
0047 containers/
0048 ├── .github/workflows/ # GitHub Actions workflows
0049 │ └── build-push.yml # Main build pipeline
0050 ├── containers/
0051 │ ├── debian/ # Base image Dockerfile
0052 │ └── eic/ # EIC image Dockerfile
0053 ├── spack-environment/ # Spack environment configurations
0054 │ ├── packages.yaml # Package versions and variants
0055 │ ├── ci/ # CI environment specs
0056 │ └── xl/ # Full (XL) environment specs
0057 ├── spack.sh # Spack version configuration
0058 ├── spack-packages.sh # Spack-packages version and cherry-picks
0059 ├── eic-spack.sh # EIC-spack repository configuration
0060 └── key4hep-spack.sh # Key4HEP-spack repository configuration
0061 ```
0062
0063 ## Support
0064
0065 For questions or issues, please visit:
0066 - [GitHub Issues](https://github.com/eic/containers/issues)
0067 - [EIC Software Working Group](https://github.com/eic)
