Skip to main content

Overview

This package provides the crunchstat-summary tool to analyze the compute performance of processes and workflows run under Arvados.

Installation

Installing under your user account

This method lets you install the package without root access. However, other users on the same system will need to reconfigure their shell in order to be able to use it. Run the following to install the package in an environment at ~/arvclients:

python3 -m venv ~/arvclients
~/arvclients/bin/pip install crunchstat-summary

Command line tools will be installed under ~/arvclients/bin. You can test one by running:

~/arvclients/bin/crunchstat-summary --version

You can run these tools by specifying the full path every time, or you can add the directory to your shell’s search path by running:

export PATH="$PATH:$HOME/arvclients/bin"

You can make this search path change permanent by adding this command to your shell’s configuration, for example ~/.bashrc if you’re using bash. You can test the change by running:

crunchstat-summary --version

Installing on Debian and Ubuntu systems

Arvados publishes packages for Debian 12 “bookworm,” Ubuntu 22.04 “jammy,” and Ubuntu 24.04 “noble.” You can install the Python SDK package on any of these distributions by running the following commands:

sudo install -d /etc/apt/keyrings
sudo curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg
sudo tee /etc/apt/sources.list.d/arvados.sources >/dev/null <<EOF
Types: deb
URIs: https://apt.arvados.org/$(lsb_release -cs)
Suites: $(lsb_release -cs)
Components: main
Signed-by: /etc/apt/keyrings/arvados.asc
EOF
sudo apt update
sudo apt install python3-crunchstat-summary

Installing on Red Hat, AlmaLinux, and Rocky Linux

Arvados publishes packages for RHEL 8 and 9, as well as distributions based on those. Note that these packages depend on, and will automatically enable, the Python 3.11 module. You can install the Python SDK package on any of these distributions by running the following commands:

sudo tee /etc/yum.repos.d/arvados.repo >/dev/null <<'EOF'
[arvados]
name=Arvados
baseurl=https://rpm.arvados.org/RHEL/$releasever/os/$basearch/
gpgcheck=1
gpgkey=https://rpm.arvados.org/RHEL/$releasever/RPM-GPG-KEY-arvados
EOF
sudo dnf install python3-crunchstat-summary

Configuration

This client software needs two pieces of information to connect to Arvados: the DNS name of the API server, and an API authorization token. The Arvados user documentation describes how to find this information in the Arvados Workbench, and install it on your system.

Testing and Development

This package is one part of the Arvados source package, and it has integration tests to check interoperability with other Arvados components. Our hacking guide describes how to set up a development environment and run tests.

Metadata

Release files for crunchstat-summary 3.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crunchstat-summary 3.2.1
File Size Uploaded
crunchstat_summary-3.2.1.tar.gz 35.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for crunchstat-summary 3.2.1
File Interpreter ABI Platform
crunchstat_summary-3.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 82.7 kB

Release files / crunchstat_summary-3.2.1.tar.gz

Download URL crunchstat_summary-3.2.1.tar.gz
Size 35.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1a27c2d8319940db2e66b9b95a17221debcea7452936f5a1002515439c89ded1
BLAKE2b-256 checksum
How to use checksums
c645a787c6f7b5deef648f96fccad12d411d305977dbd2ae1ea1d5042554d0e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.19

Release files / crunchstat_summary-3.2.1-py3-none-any.whl

Download URL crunchstat_summary-3.2.1-py3-none-any.whl
Size 46.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f324c1e10982cb6ff8f0a1f084dcd33c91d97ec55f4cb757074e667ab2d19a2c
BLAKE2b-256 checksum
How to use checksums
9b1cd7b39497b20bd98adb8521ad228a91c1e804420dd835062c22efb1aa0c91
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.19
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page