https://github.com/alumet-dev/user-book
User guide for Alumet: learn how to measure interesting metrics (including energy consumption)
https://github.com/alumet-dev/user-book
energy-consumption energy-efficiency hpc measurement monitoring profiling rust tutorial
Last synced: 6 months ago
JSON representation
User guide for Alumet: learn how to measure interesting metrics (including energy consumption)
- Host: GitHub
- URL: https://github.com/alumet-dev/user-book
- Owner: alumet-dev
- Created: 2024-04-24T14:45:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T14:25:50.000Z (9 months ago)
- Last Synced: 2025-04-28T15:39:01.925Z (9 months ago)
- Topics: energy-consumption, energy-efficiency, hpc, measurement, monitoring, profiling, rust, tutorial
- Homepage: https://alumet-dev.github.io/user-book/
- Size: 934 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The ALUMET User Book
This repository contains the "Alumet user book", a guide for the users for the users of the measurement tool: system administrators, researchers or engineers who want to measure things, etc.
## Reading the book
The book is available online (via GitHub pages) here: https://alumet-dev.github.io/user-book/
## Generating the book
The book is made with [mdBook](https://rust-lang.github.io/mdBook/).
First, you need to [install mdBook](https://rust-lang.github.io/mdBook/guide/installation.html#installation).
Then, run `mdbook`.
Example:
```sh
mdbook serve --open
```
As explained in the [mdBook documentation](https://rust-lang.github.io/mdBook/guide/creating.html#creating-a-book), `serve --open` will build the book, start a local web server and open the book in your default web browser. Modifying the source of the book will automatically reload the web page.