Sage Embedding: Difference between revisions
No edit summary |
m (Insert link to AskSage, correct comment about sage.pl) |
||
(42 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
<!-- Header for these sections -- no modification needed --> | <!-- Header for these sections -- no modification needed --> | ||
<!-- | |||
[[File:GraphicsFilename1.png|300px|thumb|right|Click to enlarge]] | |||
--> | |||
<p style="background-color:# | <p style="background-color:#f9f9f9;border:black solid 1px;padding:3px;"> | ||
This PG code shows how to embed a call to the Sage Cell Server from within a problem to insert Sage interacts, graphics, etc. See [[AskSage]] if you only need to run Sage programs. | |||
</p> | </p> | ||
Line 24: | Line 27: | ||
<pre> | <pre> | ||
DOCUMENT(); | |||
loadMacros( | |||
"PGstandard.pl", | |||
"MathObjects.pl", | |||
"sage.pl", | |||
); | |||
</pre> | </pre> | ||
Line 32: | Line 38: | ||
<td style="background-color:#ccffcc;padding:7px;"> | <td style="background-color:#ccffcc;padding:7px;"> | ||
<p> | <p> The sage.pl macro is now part of the standard WeBWorK distribution. | ||
</p> | </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<!-- Setup section --> | <!-- Setup section --> | ||
Line 47: | Line 48: | ||
<td style="background-color:#ffffdd;border:black 1px dashed;"> | <td style="background-color:#ffffdd;border:black 1px dashed;"> | ||
<pre> | <pre> | ||
############################################### | |||
## | ## | ||
## pg initializations and regular WeBWorK code | ## pg initializations and regular WeBWorK code | ||
$ | $a = random(2,5,1); | ||
$ | $ansList = List("(-cos(pi*$a)/$a + 1/$a)"); | ||
$ | |||
</pre> | </pre> | ||
</td> | </td> | ||
<td style="background-color:#ffffcc;padding:7px;"> | <td style="background-color:#ffffcc;padding:7px;"> | ||
The WeBWorK set up for the problem is the same, but in addition you have | |||
</ | to consider how you will pass the problem parameters into Sage. For example, | ||
< | if you want to pass | ||
<code>$f = (x-(-2))(x+2)(x+4)</code> it may be best to create two versions of <code>f</code>: | |||
< | <code>$f_raw = (x-(-2))*(x+2)*(x+4);</code> to pass to Sage and the math object | ||
< | <code>$f = Compute("$f_raw");</code> to use in WeBWorK. | ||
< | |||
</ | |||
<p> | <p> | ||
Also, you will need to store the list of correct answers in a variable named $ansList (which is also customizable). | |||
</p> | </p> | ||
<p> | <p> | ||
Finally, if your final answer is a matrix converted to a list, then do not use extra parenthesis here. Otherwise $ansList will be a List of Lists which is probably a bad thing. | |||
</p> | </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<!-- Initialize the Sage embedding --> | |||
<tr valign="top"> | <tr valign="top"> | ||
<td style="background-color:#ffffdd;border:black 1px dashed;"> | <td style="background-color:#ffffdd;border:black 1px dashed;"> | ||
<pre> | <pre> | ||
$SageCode = <<SAGE_CODE; | |||
Area = integrate(sin($a*x),x,0,pi) | |||
record_answer((Area)) # leave out if you return no answer | |||
SAGE_CODE | |||
</pre> | |||
</td> | |||
<td style="background-color:#ffcccc;padding:7px;"> | |||
<p> | |||
$SageCode = <<SAGE_CODE; | |||
</p> | |||
<p> | |||
denotes the beginning of the Sage Python code to be inserted into the WeBWorK problem. This will be paired at the end with and ending SAGE_CODE which must be left-justified. This portion will create a perl variable $SageCode which is the complete Python text. | |||
</p> | |||
<p>To share values computed inside the Sage cell back to the WeBWorK problem, create a single Sage list named "sageAnswer" (which is configurable).</p> | |||
</td> | |||
</tr> | |||
<!-- Sage macro and options section --> | |||
<tr valign="top"> | |||
<td style="background-color:#ffdddd;border:black 1px dashed;"> | |||
<pre> | |||
Sage( | |||
SageCode=>$SageCode, | |||
); | |||
</pre> | </pre> | ||
</td> | </td> | ||
<td style="background-color:# | <td style="background-color:#ffcccc;padding:7px;"> | ||
<p> | <p> | ||
<b>Main sage script:</b> | |||
</p> | </p> | ||
<p> | <p> | ||
Working Sage code will work verbatim except for a couple of notational changes caused by conflicting syntax between perl and sage. In particular, since "@" is used for tables in perl and for interacts in sage, one will need to replace "@" with "~~@". | |||
Further, WeBWorK uses <code>\( and \)</code> to delimit latex and "$" for variables while Sage uses "$' to delimit latex. Therefore, converting each pair of Sage's latex $ delimiters averts any conflict. | |||
</p> | </p> | ||
<p> | <p> | ||
< | The defaults for several of the customizable options: | ||
<pre> | |||
SageCode => 'print 1+2', # This is the default code if none given. | |||
ButtonText => 'Start/Restart the Interactive Cell', | |||
CellServer => 'http://sagecell.sagemath.org', | |||
SageAnswerName => 'sageAnswer', # not used yet | |||
SageAnswerValue => 'ansList', # not used yet | |||
AutoEvaluateCell => 'true', # 'false' requires student to activate cell | |||
ShowAnswerBlank => 'hidden', # Set to 'input' to see Sage answer | |||
AnswerReturn => 1, # Set to 0 if Sage returns nothing | |||
HideElements => [''], # List of items to hide in cell | |||
LinkedCells => 'false', # To allow for sharing between multiple cells | |||
</pre> | |||
</p> | </p> | ||
<p> | <p> | ||
You can hide various elements of the sage cell by listing them in the HideElements flag. Some options: | |||
<pre> | <pre> | ||
Input Elements: | |||
Editor (editor) | |||
Editor type toggle (editorToggle) | |||
Language selection box (language) | |||
Evaluate button (evalButton) | |||
Output Elements: | |||
Permalinks (permalinks) | |||
Session output (output) | |||
Session end message (done) | |||
Session files (sessionFiles) | |||
</pre> | </pre> | ||
</p> | </p> | ||
</td> | </td> | ||
Line 199: | Line 157: | ||
<!-- | |||
<!-- Answer evaluation section --> | |||
<tr valign="top"> | <tr valign="top"> | ||
<td style="background-color:# | <td style="background-color:#eeddff;border:black 1px dashed;"> | ||
<pre> | <pre> | ||
## Lower WeBWorK text | |||
## | |||
## Problem display following the Sage cell | |||
## | |||
Context()->texStrings; | |||
BEGIN_TEXT | |||
Determine the definite integral of | |||
\( \sin(${a}x) \) from \(a=0\) to \(b=\pi\). | |||
END_TEXT | |||
Context()->normalStrings; | |||
# Answer Evaluation | |||
$showPartialCorrectAnswers = 1; | |||
NAMED_ANS( sageAnswer => $ansList->cmp ); # Leave out if no Sage answer. | |||
ENDDOCUMENT(); | |||
</pre> | </pre> | ||
<td style="background-color:# | <td style="background-color:#ddddff;padding:7px;"> | ||
<p> ${a}x allows you to place the value of $a adjacent to x without a space. $ax would be interpreted as the value of | |||
a variable called ax while $a x would produce a space between the number and x. | |||
</p> | |||
<p> | <p> | ||
The | The list of values computed inside the Sage cell are sageAnswer => $ansList. | ||
</p> | </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
<p style="text-align:center;"> | |||
[[SubjectAreaTemplates|Templates by Subject Area]] | |||
</p> | |||
[[Category:Applets]] | |||
[[Category:Sample Problems]] | |||
[[Category:Subject Area Templates]] | |||
<p style="text-align:center;"> | <p style="text-align:center;"> | ||
[[IndexOfProblemTechniques|Problem Techniques Index]]<br/> | [[IndexOfProblemTechniques|Problem Techniques Index]]<br/> | ||
</p> | </p> | ||
[[Category:Problem Techniques]] | [[Category:Problem Techniques]] | ||
<!-- | |||
<ul> | <ul> | ||
<li>POD documentation: [http://webwork.maa.org/pod/pg_TRUNK/macros/AppletObjects.pl.html AppletObjects.pl.html]</li> | <li>POD documentation: [http://webwork.maa.org/pod/pg_TRUNK/macros/AppletObjects.pl.html AppletObjects.pl.html]</li> | ||
Line 260: | Line 219: | ||
</ul> | </ul> | ||
--> |
Latest revision as of 21:35, 16 September 2021
Using the Sage Cell Server
This PG code shows how to embed a call to the Sage Cell Server from within a problem to insert Sage interacts, graphics, etc. See AskSage if you only need to run Sage programs.
PG problem file | Explanation |
---|---|
DOCUMENT(); loadMacros( "PGstandard.pl", "MathObjects.pl", "sage.pl", ); |
The sage.pl macro is now part of the standard WeBWorK distribution. |
############################################### ## ## pg initializations and regular WeBWorK code $a = random(2,5,1); $ansList = List("(-cos(pi*$a)/$a + 1/$a)"); |
The WeBWorK set up for the problem is the same, but in addition you have
to consider how you will pass the problem parameters into Sage. For example,
if you want to pass
Also, you will need to store the list of correct answers in a variable named $ansList (which is also customizable). Finally, if your final answer is a matrix converted to a list, then do not use extra parenthesis here. Otherwise $ansList will be a List of Lists which is probably a bad thing. |
$SageCode = <<SAGE_CODE; Area = integrate(sin($a*x),x,0,pi) record_answer((Area)) # leave out if you return no answer SAGE_CODE |
$SageCode = <<SAGE_CODE; denotes the beginning of the Sage Python code to be inserted into the WeBWorK problem. This will be paired at the end with and ending SAGE_CODE which must be left-justified. This portion will create a perl variable $SageCode which is the complete Python text. To share values computed inside the Sage cell back to the WeBWorK problem, create a single Sage list named "sageAnswer" (which is configurable). |
Sage( SageCode=>$SageCode, ); |
Main sage script:
Working Sage code will work verbatim except for a couple of notational changes caused by conflicting syntax between perl and sage. In particular, since "@" is used for tables in perl and for interacts in sage, one will need to replace "@" with "~~@".
Further, WeBWorK uses The defaults for several of the customizable options: SageCode => 'print 1+2', # This is the default code if none given. ButtonText => 'Start/Restart the Interactive Cell', CellServer => 'http://sagecell.sagemath.org', SageAnswerName => 'sageAnswer', # not used yet SageAnswerValue => 'ansList', # not used yet AutoEvaluateCell => 'true', # 'false' requires student to activate cell ShowAnswerBlank => 'hidden', # Set to 'input' to see Sage answer AnswerReturn => 1, # Set to 0 if Sage returns nothing HideElements => [''], # List of items to hide in cell LinkedCells => 'false', # To allow for sharing between multiple cells You can hide various elements of the sage cell by listing them in the HideElements flag. Some options: Input Elements: Editor (editor) Editor type toggle (editorToggle) Language selection box (language) Evaluate button (evalButton) Output Elements: Permalinks (permalinks) Session output (output) Session end message (done) Session files (sessionFiles) |
## Lower WeBWorK text ## ## Problem display following the Sage cell ## Context()->texStrings; BEGIN_TEXT Determine the definite integral of \( \sin(${a}x) \) from \(a=0\) to \(b=\pi\). END_TEXT Context()->normalStrings; # Answer Evaluation $showPartialCorrectAnswers = 1; NAMED_ANS( sageAnswer => $ansList->cmp ); # Leave out if no Sage answer. ENDDOCUMENT(); |
${a}x allows you to place the value of $a adjacent to x without a space. $ax would be interpreted as the value of a variable called ax while $a x would produce a space between the number and x. The list of values computed inside the Sage cell are sageAnswer => $ansList. |