Skip to content

Commit ab7b520

Browse files
committed
Updated table of contents
1 parent 48689ac commit ab7b520

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,27 @@ A set of Python programs to monitor, collect, and digest metrics of a given Linu
88

99
## Table of Contents
1010

11+
<!-- ToC begin -->
12+
<a name="toc"></a>
13+
1114
- [`treecript`: Process Tree Metrics Transcriptor](#treecript-process-tree-metrics-transcriptor)
1215
- [Table of Contents](#table-of-contents)
1316
- [Repository Structure](#repository-structure)
1417
- [Installation](#installation)
15-
- [Prerequisites](#prerequisites)
18+
- [Prerequisites (singularity)](#prerequisites-singularity)
19+
- [Prerequisites (native)](#prerequisites-native)
1620
- [Not sure which installation method to use?](#not-sure-which-installation-method-to-use)
17-
- [Choosing a constraints file](#choosing-a-constraints-file)
18-
- [Option 1: pip + virtual environment (venv)](#option-1-pip--virtual-environment-venv)
19-
- [Option 2: Conda environment](#option-2-conda-environment)
21+
- [Choosing a constraints file (only needed for option 2 or option 3)](#choosing-a-constraints-file-only-needed-for-option-2-or-option-3)
22+
- [Option 1: Singularity](#option-1-singularity)
23+
- [Alternative A: Fetch a pre-built image (only for metrics gathering)](#alternative-a-fetch-a-pre-built-image-only-for-metrics-gathering)
24+
- [Alternative B: Building from source](#alternative-b-building-from-source)
25+
- [Option 2: pip + virtual environment (venv)](#option-2-pip--virtual-environment-venv)
26+
- [Option 3: Conda environment](#option-3-conda-environment)
2027
- [Installing Miniconda (if not already installed)](#installing-miniconda-if-not-already-installed)
2128
- [Creating the treecript conda environment](#creating-the-treecript-conda-environment)
2229
- [Verifying the installation](#verifying-the-installation)
23-
- [Quick Start](#quick-start)
30+
- [Quick Start (Singularity/Apptainer)](#quick-start-singularityapptainer)
31+
- [Quick Start (other options)](#quick-start-other-options)
2432
- [Programs Reference](#programs-reference)
2533
- [Collecting metrics](#collecting-metrics)
2634
- [Plotting time series charts](#plotting-time-series-charts)
@@ -38,7 +46,8 @@ A set of Python programs to monitor, collect, and digest metrics of a given Linu
3846
- [`plotGraph.sh`](#plotgraphsh)
3947
- [`plot-metrics.sh`](#plot-metricssh)
4048
- [License](#license)
41-
49+
<!-- Generated by gh-toc, https://moonbase59.github.io/gh-toc/ -->
50+
<!-- ToC end -->
4251
---
4352

4453
## Repository Structure

0 commit comments

Comments
 (0)