Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Register
  • Sign in
  • EAR EAR
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Releases
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • EAR_teamEAR_team
  • EAREAR
  • Wiki
  • User guide

User guide · Changes

Page history
Some user's guide links fixed authored May 20, 2025 by Oriol's avatar Oriol
Show whitespace changes
Inline Side-by-side
User-guide.md
View page @ 225f401b
...@@ -101,8 +101,7 @@ You can read [here](https://www.intel.com/content/www/us/en/develop/documentatio ...@@ -101,8 +101,7 @@ You can read [here](https://www.intel.com/content/www/us/en/develop/documentatio
For joining OpenMPI and EAR it is highly recommended to use SLURM's `srun` command. For joining OpenMPI and EAR it is highly recommended to use SLURM's `srun` command.
When using `mpirun`, as OpenMPI is not fully coordinated with the scheduler, EARL When using `mpirun`, as OpenMPI is not fully coordinated with the scheduler, EARL
is not automatilly loaded on all nodes. is not automatilly loaded on all nodes.
Therefore EARL will be disabled and only [basic energy metrics](#jobs-executed-without-the-ear-library-basic-job-accounting) Therefore EARL will be disabled and only basic energy metrics will be reported.
will be reported.
To provide support for this workflow, EAR provides [`erun`](EAR-commands#erun) command. To provide support for this workflow, EAR provides [`erun`](EAR-commands#erun) command.
Read the corresponding [examples section](User-guide.md#openmpi-1) for more information about how to use this command. Read the corresponding [examples section](User-guide.md#openmpi-1) for more information about how to use this command.
...@@ -200,7 +199,7 @@ mpirun -np 64 singularity exec $IMAGE $EAR_INSTALL_PATH/bin/erun \ ...@@ -200,7 +199,7 @@ mpirun -np 64 singularity exec $IMAGE $EAR_INSTALL_PATH/bin/erun \
--program=$BENCH_PATH/bt-mz.D.64 --program=$BENCH_PATH/bt-mz.D.64
``` ```
Note that the example exports `APPTAINERENV_EAR_REPORT_ADD` to set the environment variable [`EAR_REPORT_ADD`](EAR-environment-variables#report-plug-ins) to load [`sysfs`](Report#sysfs-report-plugin) report plug-in. Note that the example exports `APPTAINERENV_EAR_REPORT_ADD` to set the environment variable [`EAR_REPORT_ADD`](EAR-environment-variables#report-plug-ins) to load [`sysfs`](https://gitlab.bsc.es/ear_team/ear/-/wikis/Report#sysfs-report-plugin) report plug-in.
See [next section](#runtime-report-plug-ins) about report plug-ins. See [next section](#runtime-report-plug-ins) about report plug-ins.
## Using EARL through the COMPSs Framework ## Using EARL through the COMPSs Framework
...@@ -244,11 +243,11 @@ You can load this plug-in in two ways: ...@@ -244,11 +243,11 @@ You can load this plug-in in two ways:
1. By setting [`--ear-user-db`](#ear-job-submission-flags) flag at submission time. 1. By setting [`--ear-user-db`](#ear-job-submission-flags) flag at submission time.
2. [Loading directly the report plug-in](EAR-environment-variables#ear_report_add) through an environment variable: `export EAR_REPORT_ADD=csv_ts.so`. 2. [Loading directly the report plug-in](EAR-environment-variables#ear_report_add) through an environment variable: `export EAR_REPORT_ADD=csv_ts.so`.
Read [report plug-ins](Report) dedicated section for more information. Read [report plug-ins](https://gitlab.bsc.es/ear_team/ear/-/wikis/Report) dedicated section for more information.
## Other EARL events ## Other EARL events
You can also request EAR to report **events** to the [Database](EAR-Databse). You can also request EAR to report **events** to the [Database](https://gitlab.bsc.es/ear_team/ear/-/wikis/EAR-Database).
They show more details about EARL internal state and can be provided with `eacct` command. They show more details about EARL internal state and can be provided with `eacct` command.
See how to enable [EAR events reporting](EAR-environment-variables#report_earl_events) and which kind of events EAR is reporting. See how to enable [EAR events reporting](EAR-environment-variables#report_earl_events) and which kind of events EAR is reporting.
...@@ -582,5 +581,5 @@ The core component of EAR at the user's job level is the EAR Library (EARL). ...@@ -582,5 +581,5 @@ The core component of EAR at the user's job level is the EAR Library (EARL).
The Library deals with job monitoring and is the component which implements and applies The Library deals with job monitoring and is the component which implements and applies
optimization policies based on monitored workload. optimization policies based on monitored workload.
**We highly recommend you** to read [EARL](EARL) documentation and also how energy policies work **We highly recommend you** to read [EARL](https://gitlab.bsc.es/ear_team/ear/-/wikis/Architecture#the-ear-library-job-manager) documentation and also how energy policies work
in order to better understand what is doing the Library internally, so you will can explore easily all features (e.g., tunning variables, collecting data) EAR offers to the end-user so you will have more knowledge about how much resources your application consumes and how to correlate with its computational characteristics. in order to better understand what is doing the Library internally, so you will can explore easily all features (e.g., tunning variables, collecting data) EAR offers to the end-user so you will have more knowledge about how much resources your application consumes and how to correlate with its computational characteristics.
Clone repository
  • Home
  • User guide
    • Use cases
      • MPI applications
      • Non-MPI applications
      • Other use cases
      • Usage inside Singularity containers
      • Usage through the COMPSs Framework
    • EAR data
      • Post-mortem application data
      • Runtime report plug-ins
      • EARL events
      • MPI stats
      • Paraver traces
      • Grafana
    • Submission flags
    • Examples
    • Job accounting
    • Job energy optimization
  • Tutorials
  • Commands
    • Job accounting (eacct)
    • System energy report (ereport)
    • EAR control (econtrol)
    • Database management
    • erun
    • ear-info
  • Environment variables
    • Support for Intel(R) speed select technology
  • Admin Guide
    • Quick installation guide
    • Installation from RPM
    • Updating
  • Installation from source
  • Architecture/Services
  • High Availability support
  • Configuration
  • Learning phase
  • Plug-ins
  • Powercap
  • Report plug-ins
  • Database
    • Updating the database from previous EAR versions
    • Tables description
  • Supported systems
  • EAR Data Center Monitoring
  • CHANGELOG
  • FAQs
  • Known issues