Commit a88b3760 authored by Olivier's avatar Olivier
Browse files

Cleanup/remove deprecated documentation

parent 8fa983bf
Script: assign_customizer.py
============================
## Description
This script takes a `tex` file with marked parameters and a list of students matriculation numbers to produce a new `tex` file with custom parameters for each student and a `csv` file with all the output assignments data.
The input files should be placed in the `script_input` folder which is in the same path as the script. The output files will be saved in the `script_output` folder.
## Script input
1. `parameters.tex`: file containing the parameters, with markers on the places where the values should be customized, for example: `XXlengthXX`, `XXdiameterXX`.
1. `canonical.csv`: file with the students data, example:
| name | lastname | email | matrikel|
|---|---|---|---|
|Theodore |Von Kármán |example1@ovgu.de |123456|
|Osborne |Reynolds |example2@st.ovgu.de |123457|
1. `assignment_info.csv`: file with the range for the marked values.
|find_marker |range_min |range_max |round_off_decimals
|---|---|---|---|
|XXpipediameterXX |0.5 |3 |1|
|XXpipelengthXX |100 |350 |0|
|XXmassflowXX |1.5 |4 |1|
## Script output
1. `output_assignments.csv`: file with a summary of all the output data.
1. `parameters_ID_xxxxxxxx`: one `tex` file, with custom parameters, for each student.
......@@ -3,26 +3,8 @@ Script: create_pdfs.sh
## Description
This script takes a series of `tex` files containing each a series of LaTeX variables with custom values, and produces, for each of those, a pair of `pdf` files: one contaning the assignment, and the other containing the corresponding solution.
The input files should be placed in the `script_input` folder which is in the same path as the script. The output files will be saved in the `script_output` folder.
This script takes a series of `tex` files containing each a series of LaTeX variables with custom values, and produces, for each of those, a `pdf` file. In total, for each participant, there should be one assignment, one solution to be later sent to peers, and one solution to be later sent back to the participant.
## Dependencies
The script is run in a bash shell on a Ubuntu system. It makes use of the `pdflatex` compiler. The example `tex` file uses stylesheets from the [sensible styles](https://git.framasoft.org/u/olivier/sensible-styles) library.
## Script input
1. One `sample_problem_assignment.tex` and one `sample_problem_solution.tex` file, containing the basic LaTeX templates for the assignment and solution of the problem.
1. Any number of `parameters_ID_xxxxxxxx.tex` files, with xxxxxxxx the custom ID for each student, containing declarations for LaTeX variables and their numerical values, for example:
\newcommand{\codenumber}{17688816}
\newcommand{\pipediameter}{1.9}
\newcommand{\pipelength}{349.0}
\newcommand{\viscosity}{1.2e-2}
## Script output
For each input file, a pair of files named `assignment_ID_xxxxxxxx.pdf` and `solution_ID_xxxxxxxx.pdf`.
The script is run in a bash shell on a Ubuntu system. It makes use of the `pdflatex` compiler. The example `tex` file uses stylesheets from the [sensible styles](https://framagit.org/olivier/sensible-styles) library.
......@@ -18,23 +18,3 @@ This script sends personalized emails with attachments.
1. One personalized email per student, at a controlled rate in order not to exceed local network limitations;
1. `sent_emails.csv` : file with the log of the sent emails
This script takes a list of the students who received customized assignments and the pdf files sent by them. Then it assigns two peers (reviewers) to each student, except to students that did not submit any solution to their assignment.
The output of the script is a `csv` file containing the consolidated data.
The input files should be placed in the `script_input` folder which is in the same path as the script. The output files will
be saved in the `script_output` folder.
## Script input
1. `output_assignments.csv`: This file contains the data from the students including their custom ID. It is the output file from the script [assign_customizer.py](../M2_customize_assignments/assign_customizer.py) from [module 2](../M2_customize_assignments).
1. All the `pdf` files with the solutions submitted by the students, named as: `customID.pdf` (for example `12345678.pdf`).
## Script output
1. `peers.csv`: file with the assigned peers for each student.
1. renamed pdfs, ready to be sent for grading: `ID_A.pdf``ID_G.pdf`
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment