-
Simon Tournier authored* README.activity-report: Update.
Simon Tournier authored* README.activity-report: Update.
README.activity-report 10.86 KiB
# -*- mode:org -*-
#+STARTUP: show4levels
#+STARTUP: indent
#+TODO: TODO TODOs | DONE
You are an editor for the next Guix-HPC activity report, congrats!
This file describes the various steps you need to complete in order to publish
the activity report. **The goal is to publish it on the second week of
February.**
Don’t be afraid by this checklist, it’s a very smooth process. An advice:
for any doubt, ask!
* Check list [0/13]
** TODO **Clone** the Git repository https://gitlab.inria.fr/guix-hpc/website
** TODO **August**: Get in touch with a designer such as [[https://luis-felipe.gitlab.io/][Luís Felipe]]
_Note_: If possible, order a new design for the cover; financial support can
be solicited from [[https://foundation.guix.info][Guix Foundation]].
** TODOs [0/5] **November**: Open the activity report
*** TODO Create the folder drafts/ if required
*** TODO Create the markwdown file drafts/activity-report-20XY.md and insert the template (see below)
*** TODO Be careful with placeholders from the template file (XY, etc.)
*** TODO Send an email to all the authors of the previous activity report, asking for contributions
*** TODO Contact other potential contributors to the report
** TODO **December** / **January**: Friendly reminder and/or ping
** TODOs [0/4] **Contributions**
*** TODO For contributions sent by email: Commit with the author information
_Note_: Tracking the name and the email in the commit message is helpful to
contact the contributors again.
_Note_: At worst, add Authored-by: or Co-authored-by: in the commit message.
*** TODO When co-author: Add the trailing Co-authored-by: Alice Carol <alice@carol.org>
_Note_: One Co-authored-by: line per co-author.
*** TODO Double check grammar and spelling
*** TODO Do not refrain (?) about the hyperlinks to external resource
** TODO The editor writes the introduction and "Perspectives" section
_Note_: The introductory paragraphs are mostly boilerplate that presents
Guix-HPC. But there is also a sentence or two summarizing the
highlights of the year.
_Note_: The "Perspectives" section at the end of the report is a high-level
outlook on future directions for Guix-HPC. Challenges, opportunities,
etc.
Once you have a draft, ask the author community for feedback.
** TODO Update the PDF cover file with the year (see file doc/build.scm)
_Note_: The activity report (Makdown format) is then published in three
formats:
- as a blog post;
- as a PDF file;
- as a PDF A5 booklet file for printing and folding.
The last two formats include a nice cover page. It contains the year
number, so it has to be updated every year. You may also tweak the
graphics for visual diversity, but that's optional.
The current cover PDF file is named
=orbital-spheres-plus-cover-20XY.pdf=.
** TODOs [0/3] **January**: Ask for a last round of collective double-checking
*** TODO Check uniformity of Talks and Events
*** TODO Check the "Personnel" section and ping the usual suspects
*** TODO Check for typos, “quotes”, **highlights**, dashes –, spaces
** TODOs [0/11] **February**: Publish!
*** TODO Move from drafts/activity-report-20XY.md to posts/activity-report-20XY.md
*** TODO Be careful with the placeholders from the template file (XY, etc.)
*** TODOs [0/3] Update the "author:" field in the header
**** TODO Alphabetically sorted by last name
**** TODO Tips: =git log= / =git blame=
**** TODO Do not miss "Authored-by:" or "Co-authored-by:"
*** TODO Adjust the "date:" field in the header
*** TODOs [0/3] Adapt the file doc/build.scm
**** TODO Replace the placeholder XY in the file [[file:doc/build.scm][doc/build.scm]]
_Note_: See the last lines of the file.
#+begin_src scheme
(latex->pdf (markdown->latex (local-file "../posts/activity-report-20XY.md"))
"activity-report-2024.tex")
#+end_src
**** TODO Adjust the variable %editors (replace the names, put yours)
_Note_: See between the lines 125 and 155; guess 139?
**** TODO Adapt the PDF cover =orbital-spheres-plus-cover-20XY.pdf=
*** TODO Generate the two PDFs: =guix build -f doc/build.scm=
*** TODOs [0/5] Double-check the PDFs
**** TODO page numbering
**** TODO empty blank pages
_Note_: The booklet must properly render, with cover and back-cover appearing
on the same A4 sheet
**** TODO author list
**** TODO editor name
**** TODO date
*** TODO Try hard to have at least one **bold term** for each section, subsection, subsubsection
*** TODO cp $(guix build -f doc/build.scm)/*.pdf doc/static/
*** TODO Locally build the website (see instructions in [[file:README][README]] file)
*** TODO Yeah push! Congrats! :-)
** TODO Publish on https://hal.science/
_Note_: See https://hal.science/search/index?q=Guix-HPC+Activity+Report for
the already published reports, from where you can copy most of the
metadata.
** TODOs [0/3] Spread the word
*** TODO Announce to @all on https://mattermost.univ-nantes.fr/cafe-guix
*** TODO guix-science@gnu.org
*** TODO your favorite mailing lists
** TODO **February** Print hard copies of the booklet to distribute at relevant venues
** TODO **June**: Appoint the new Editors; preferably two;
* _Notes_
** Placeholders XY, XY-1, XY+1, etc.
Where XY matches the current year.
_Note_: + The report is released on February XY+1.
+ The report covers mainly the year XY, + The cover mentions the years (XY-1)--XY.
+ Example: activity-report-2024.md
+ release on Feb. 2025
+ main year 2024
+ cover 2023-2024
** Template for the activity report
_Note_: Double check the various placeholders: XY, XY-1, <nth>, etc.
This template is a suggestion; Feel free to unleash your creativity.
#+begin_src markdown :tangle drafts/activity-report-20XY.md
title: Guix-HPC Activity Report, 20XY
author: <list alphabetically sorted of all the contributors>
date: 20XY-02-nm 15:30
slug: guix-hpc-activity-report-20XY
pdf: /static/doc/activity-report-202XY.pdf
pdf-booklet: /static/doc/activity-report-20XY-booklet.pdf
pdf-cover: /static/images/blog/activity-report-20XY-cover.webp
tags: Community, Activity Report, High-performance computing, Research
---
Guix-HPC is a collaborative effort to bring **reproducible software
deployment to scientific workflows and high-performance computing** (HPC).
Guix-HPC builds upon the [GNU Guix](https://guix.gnu.org) software
deployment tools and aims to make them useful for HPC practitioners and
scientists concerned with dependency graph control and customization
and, uniquely, reproducible research.
Guix-HPC started as a joint software development project involving three
research institutes: [Inria](https://www.inria.fr/en/), the [Max
Delbrück Center for Molecular Medicine
(MDC)](https://www.mdc-berlin.de/), and the [Utrecht Bioinformatics
Center (UBC)](https://ubc.uu.nl/). Guix for HPC and reproducible
research has since received contributions from many individuals and
organizations, including [CNRS](https://www.cnrs.fr/en), [Université
Paris Cité](https://u-paris.fr/en/), the [University of Tennessee Health
Science Center](https://uthsc.edu/) (UTHSC), [Cornell
University](https://www.csl.cornell.edu/), and
[AMD](https://www.amd.com). HPC remains a conservative domain but over
the years, we have reached out to many organizations and people who
share our goal of improving upon the status quo when it comes to
software deployment.
This report—our TODO report!—highlights key achievements of Guix-HPC between
[our previous
report](https://hpc.guix.info/blog/20XY/02/guix-hpc-activity-report-20(XY-1/)
a year ago and today, February 20(XY+1). This year was marked by exciting
developments for HPC and reproducible workflows. Significant advances were
made in integrating Guix into the complex software landscape of HPC, taking
the roles of software manager, workflow execution engine, backend for
generating container images, or provider for the complete operating system
layer. Support for reproducing computations from the past was also much
improved. And, as usual, we have been using Guix for research, and teaching
other researchers how to get started.
# Outline
Guix-HPC aims to tackle the following high-level objectives:
- *Reproducible scientific workflows.* Improve the GNU Guix tool set
to better support reproducible scientific workflows and to simplify
sharing and publication of software environments.
- *Cluster usage.* Streamlining Guix deployment on HPC clusters, and
providing interoperability with clusters not running Guix.
- *Outreach & user support.* Reaching out to the HPC and scientific
research communities and organizing training sessions.
The following sections detail work that has been carried out in each of
these areas.
# Reproducible Scientific Workflows
## Packages
## Reproducible Research in Practice
# Cluster Usage and Deployment
# Outreach and User Support
Guix-HPC is in part about “spreading the word” about our approach to
reproducible software environments and how it can help further the goals of
reproducible research and high-performance computing development. This section
summarizes talks and training sessions given this year.
## Articles
The following refereed articles about Guix were published:
- Alice, Blake, and Carole [_The Titile The Rocks_](https://link/to/article)
## Talks
Since last year, we gave the following talks at the following venues:
- [_The Titile The Rocks_](https://link/to/article)
ConfName/SeminarName, Month 20XY (Alice)
## Events
## Training Sessions
# Personnel
# Perspectives
#+end_src
** Template email
Below a suggestion for a template email.
_Note_: Replace XY, XY-1 and <your-name>.
#+begin_src text
Hello!
It’s that time of the year again! I’m emailing you because you
contributed to annual reports in the past and/or to Guix and/or to
Guix-HPC in some way, and I thought you may be willing to contribute to
this year’s activity report. For the record, here’s last year’s report:
https://hpc.guix.info/blog/20XY/02/guix-hpc-activity-report-20(XY-1)/
Here the template, following the same structure:
https://gitlab.inria.fr/guix-hpc/website/-/blob/master/drafts/activity-report-20XY.md
The goal is to publish it on the second week of February.
You’re very welcome to contribute things you’ve done with Guix, in Guix,
or around Guix, HPC, and reproducible research in the past year. For a
start, you can add pointers to talks or training sessions you gave and
to papers you published in the relevant sections. (Feel free to push if
you have commit access; if you don’t, we can create an account for you,
or you can send patches be email.)
Any suggestion you may have about how to structure the document is very
welcome.
Cheers,
<your-name> on the behalf of the editors
#+end_Src