From 9e754148a9cf7a781967dfb0b42043ee69c0de1c Mon Sep 17 00:00:00 2001 From: Simon Rey Date: Tue, 12 Nov 2024 17:08:02 +0100 Subject: [PATCH] Readme++ --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ed04390..ff42772 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,28 @@ [![Build badge](https://github.com/COMSOC-Community/easychair-extra/workflows/build/badge.svg)](https://github.com/COMSOC-Community/easychair-extra/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/COMSOC-Community/easychair-extra/branch/main/graphs/badge.svg)](https://codecov.io/gh/COMSOC-Community/easychair-extra/tree/main) -Python package to work with files exported from EasyChair. -Useful to develop tools when running a conference. +This repository contains a Python package for working with files exported from EasyChair. +It provides ready-made functionalities to develop tools useful for organizing large-scale +conferences. -This package came to life when Ulle Endriss was a PC chair for ECAI-2024. For this role, many tools -enhancing the functionality provided by EasyChair were needed. The tools that could benefit the -community have been gathered there. +This package was created when Ulle Endriss served as the PC Chair for ECAI 2024. In this role, +many tools were needed to enhance EasyChair's functionality. The tools with potential benefit +for the broader community have been gathered here. + +The files in this repository serve as building blocks for scripts used in conference management. +We provide functions for reading and generating EasyChair files, as well as performing useful +tasks (e.g., creating review assignments). + +We provide example scripts show-casing how they can be used. We have for instances scripts to: + +- Compute the minimum "review quota", that is, the smallest maximum number of reviews per reviewers +so that it is still possible to assign each paper 3 reviewers who did not bid negatively for it; +- Form a pool of emergency reviewers, these are reviewers with versatile skills that can be used +last minute for emergency reviews; +- Group submissions by similarity as an intermediary step before constructing the conference schedule. + +The files in this repository are designed to help you kick-start the development of the scripts +needed for your conference! ## The Package