Skip to main content
Ctrl+K

Documentation

  • Home page
  • User Guide
  • Dev Doc
  • Examples
  • Python API
  • C++ API
  • GitHub
  • Website
  • Home page
  • User Guide
  • Dev Doc
  • Examples
  • Python API
  • C++ API
  • GitHub
  • Website

Section Navigation

Contents

  • Getting Started
    • Shamrock install (Spack)
    • Shamrock install (Homebrew)
    • Shamrock install (Docker)
    • Shamrock install (From source)
    • Linux (Debian/Ubuntu) Configuration
    • macOS Configuration
    • Conda Environment Configuration
  • Using Shamrock with Python venv
  • Using Shamrock on GPUs
  • Build environments in Shamrock
  • User Guide

User Guide#

Welcome to the user guide

Contents

  • Getting Started
    • Installation
    • Prerequisite
    • Doing the setup
    • Starting Shamrock
    • Next steps
  • Using Shamrock with Python venv
    • Creating the venv and installing basic utilities
    • Use it with Shamrock
  • Using Shamrock on GPUs
  • Build environments in Shamrock
    • The new-env script
    • Environment reset functionality

previous

Welcome to Shamrock’s documentation!

next

Getting Started

Edit on GitHub
Show Source

© Copyright 2020 -- 2026 Timothee David--Cléris.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.17.1.