Using AMC in command line only

Version 12 (Alex Alex, 03/07/2021 12:05 am)

1 1
h1. Using AMC in command line only
2 1
3 1
(under construction)
4 1
5 1
These instructions should help you use AMC in command line only without having to open the graphical user interface.
6 1
These instructions work with version 1.1.0 of AMC.
7 1
8 12 Alex Alex
Note that when you run AMC graphical interface and begin a debugging session (from the Help menu), all AMC commands called by the graphical interface will be recorded in the log file. This can help you to figure out which exact command can do what you need.
9 1
10 12 Alex Alex
Additionnaly, if you ever need to open the GUI, the commands described here are all compatible with AMC-gui.pl.
11 12 Alex Alex
12 1
h2. Creating a new project
13 1
14 4 Alex Alex
There is no AMC command to create a new project, so you will need to create directories "manually". I use the following bash script to create the directories:
15 1
16 1
<pre>
17 1
#!/bin/bash
18 1
# file name: new_project.sh
19 3 Alex Alex
PROJECT_DIR=$HOME/MC-Projects
20 1
21 1
mkdir $PROJECT_DIR/$1
22 1
mkdir $PROJECT_DIR/$1/cr
23 1
mkdir $PROJECT_DIR/$1/cr/corrections
24 1
mkdir $PROJECT_DIR/$1/cr/corrections/jpg
25 1
mkdir $PROJECT_DIR/$1/cr/corrections/pdf
26 1
mkdir $PROJECT_DIR/$1/cr/diagnostic
27 1
mkdir $PROJECT_DIR/$1/cr/zooms
28 1
mkdir $PROJECT_DIR/$1/data
29 1
mkdir $PROJECT_DIR/$1/exports
30 1
mkdir $PROJECT_DIR/$1/scans
31 6 Alex Alex
mkdir $PROJECT_DIR/$1/copies
32 1
</pre>
33 1
34 1
then you can create a new poject by typing:
35 1
<pre>
36 4 Alex Alex
$ ./new_project.sh my-new-project1
37 1
</pre>
38 2 Alex Alex
39 2 Alex Alex
h2. Prepare tests
40 1
41 1
You need to have your .tex file created before following with the instructions below.
42 4 Alex Alex
In the following examples, we will suppose that your latex file name is test.tex
43 1
44 1
h3. Creating the PDFs
45 4 Alex Alex
46 4 Alex Alex
The next step consists of creating the subject file, the correction file and the position file. By typing:
47 4 Alex Alex
48 1
<pre>
49 4 Alex Alex
$ cd ~/MC-Projects/my-new-project1/
50 4 Alex Alex
$ auto-multiple-choice prepare --mode s --prefix ./ ./test.tex \
51 4 Alex Alex
    --out-sujet DOC-subject.pdf \
52 4 Alex Alex
    --out-corrige DOC-correction.pdf \
53 4 Alex Alex
    --out-calage DOC-calage.xy
54 1
</pre>
55 4 Alex Alex
56 4 Alex Alex
This command will create 3 files:
57 4 Alex Alex
* DOC-subject.pdf is a file containing all copies.
58 4 Alex Alex
* DOC-correction.pdf is a file with the correct answer checked so you can review the answers.
59 4 Alex Alex
* DOC-calage.xy is the position file.
60 1
61 6 Alex Alex
You also need to extract the scroing data from the source file. Typing from your project directory:
62 1
63 2 Alex Alex
<pre>
64 6 Alex Alex
$ auto-multiple-choice prepare --mode b --prefix ./ ./test.tex --data ./data/
65 1
</pre>
66 5 Alex Alex
67 6 Alex Alex
This command will create various SQLite files in the data directory.
68 1
69 6 Alex Alex
h3. Prepare the layout information
70 2 Alex Alex
71 6 Alex Alex
The following command will get the layout information from the working document to the layout database:
72 6 Alex Alex
73 2 Alex Alex
<pre>
74 7 Alex Alex
$ auto-multiple-choice meptex --src $PROJECT_DIR/$1/DOC-calage.xy --data $PROJECT_DIR/$1/data
75 1
</pre>
76 1
77 2 Alex Alex
h3. Printing your documents
78 2 Alex Alex
79 6 Alex Alex
You can use the DOC-subject.pdf file and print it. However, if you want to create separate files for each students, type the following:
80 6 Alex Alex
81 1
<pre>
82 7 Alex Alex
$ auto-multiple-choice imprime --sujet ./DOC-subject.pdf \ 
83 7 Alex Alex
    --data ./data/ \ 
84 7 Alex Alex
    --methode file \ 
85 7 Alex Alex
    --output ./copies/test-%e.pdf
86 2 Alex Alex
</pre>
87 2 Alex Alex
88 8 Alex Alex
h2. Analyzing the copies
89 2 Alex Alex
90 8 Alex Alex
Once you have scanned all the student's copies, place them in the scans/ directory. The next command will analyze all the files in the scans/ directory.
91 1
92 8 Alex Alex
<pre>
93 8 Alex Alex
$ auto-multiple-choice analyse --projet ./ ./scans/*
94 8 Alex Alex
</pre>
95 8 Alex Alex
96 8 Alex Alex
You can also have certain files analyzed using the --list-fichiers option. Read AMC-analyse's manpage for more information.
97 2 Alex Alex
98 9 Alex Alex
<pre>
99 9 Alex Alex
$ man AMC-analyse
100 9 Alex Alex
</pre>
101 9 Alex Alex
102 9 Alex Alex
h2. Compute marks
103 9 Alex Alex
104 9 Alex Alex
Using the following command will compute the marks:
105 9 Alex Alex
106 9 Alex Alex
<pre>
107 9 Alex Alex
$ auto-multiple-choice note --data ./data --seuil 0.15
108 9 Alex Alex
</pre>
109 9 Alex Alex
110 9 Alex Alex
The "--seuil" option specifies the black ratio threshold to use. 0.15 is normally an acceptable value. If you use a separate answer sheet, you at least a 0.5 value.
111 9 Alex Alex
Read AMC-note's manpage for a list of other options that will help you with the rounding and the maximum and the minimum notes.
112 9 Alex Alex
113 9 Alex Alex
<pre>
114 10 Alex Alex
$ man AMC-note
115 9 Alex Alex
</pre>
116 1
117 10 Alex Alex
h2. Automatic association - Students and copies
118 10 Alex Alex
119 10 Alex Alex
This command will associate every copy with the student who answered.
120 10 Alex Alex
121 10 Alex Alex
<pre>
122 10 Alex Alex
$ auto-multiple-choice association-auto --data ./data --notes-id numero-etudiant --liste ./students-list.csv --liste-key no
123 10 Alex Alex
</pre>
124 10 Alex Alex
125 10 Alex Alex
The "--notes-id" option specifies the identification string used in your latex file with the \AMCcode command.
126 11 Alex Alex
The "--liste" option specifies the comma separated file with your student's name. "Read AMC's documentation to know the format of that file":http://home.gna.org/auto-qcm/auto-multiple-choice.en/graphical-interface.shtml#sec.students.id
127 1
128 11 Alex Alex
h2. Annote scan papers
129 1
130 11 Alex Alex
The following command will annotate the copies in the copies/ directory for all questions:
131 1
132 11 Alex Alex
<pre>
133 11 Alex Alex
$ auto-multiple-choice annote --projet ./ --data ./data --fich-noms students-list.csv
134 11 Alex Alex
</pre>
135 11 Alex Alex
136 11 Alex Alex
Then, you can also prepare a file for each of your student with its exam copy and answers. This command will merge your scans with a copy of your student's test: 
137 11 Alex Alex
138 11 Alex Alex
<pre>
139 11 Alex Alex
$ auto-multiple-choice regroupe --projet ./ --sujet DOC-subject.pdf --fich-noms students-list.csv --tex-src test.tex --compose
140 11 Alex Alex
</pre>
141 11 Alex Alex
142 11 Alex Alex
This will create files in the cr/corrections/pdf/ directory. One file per student.
143 11 Alex Alex
Read AMC-regroupe manpage for other options.
144 11 Alex Alex
145 11 Alex Alex
h2. Export marks
146 11 Alex Alex
147 11 Alex Alex
If you want a spreadsheet with the marks, you can type the following command:
148 11 Alex Alex
149 11 Alex Alex
<pre>
150 11 Alex Alex
auto-multiple-choice export --data ./data \
151 11 Alex Alex
  --module ods \
152 11 Alex Alex
  --fich-noms students-list.csv \
153 1
  --o output-note.ods
154 12 Alex Alex
</pre>
155 12 Alex Alex
156 12 Alex Alex
h2. Other commands
157 12 Alex Alex
158 12 Alex Alex
If you want to mail PDF annotated answer sheets to students, look at the AMC-mailing command:
159 12 Alex Alex
160 12 Alex Alex
<pre>
161 12 Alex Alex
$ man AMC-mailing
162 11 Alex Alex
</pre>