diff options
| -rw-r--r-- | getting_started_with_sage_notebook/script.rst | 154 |
1 files changed, 151 insertions, 3 deletions
diff --git a/getting_started_with_sage_notebook/script.rst b/getting_started_with_sage_notebook/script.rst index 128a2e5..7daeef0 100644 --- a/getting_started_with_sage_notebook/script.rst +++ b/getting_started_with_sage_notebook/script.rst @@ -32,14 +32,22 @@ Script ------ +.. L1 + {{{ Show the first slide containing title, name of the production team along with the logo of MHRD }}} +.. R1 + Hello friends and Welcome to this spoken tutorial on "Getting started with Sage and Sage notebook". +.. L2 + {{{ Show the slide containing objectives }}} +.. R2 + At the end of this tutorial, you will be able to, #. Know what Sage and Sage notebook are. @@ -52,8 +60,12 @@ At the end of this tutorial, you will be able to, #. Use code from other languages in the cells. #. Use the offline help available. +.. L3 + {{{ Show the slide on what is Sage }}} +.. R3 + To start with, What is Sage? Sage is a free, open-source mathematical software. Sage can do a lot of math stuff for you including, but not limited to, algebra, calculus, geometry, cryptography, graph theory @@ -61,25 +73,36 @@ among other things. It can also be used as an aid in teaching and research in any of the areas that Sage supports. So let us start Sage now +.. L4 + {{{ Show slide 'Installing Sage' }}} +.. R4 + We are assuming that you have Sage installed on your computer now. If not please visit the page http://sagemath.org/doc/tutorial/introduction.html#installation for the tutorial on how to install Sage. +.. L5 + {{{ Open the terminal }}} +.. R5 + Let us now learn how to start Sage. On the terminal type + +.. L6 :: sage -This should start a new Sage shell with the prompt sage: which looks -like this - {{{ Show what is displayed on the terminal }}} +.. R6 + +This should start a new Sage shell with the prompt sage: + So now we can type all the commands that Sage supports here. But Sage comes bundled with a much more elegant tool called Sage Notebook.So what is Sage Notebook? Sage Notebook provides a web based @@ -95,10 +118,14 @@ is very handy for research and teaching. However we can also run our own instances of Sage notebook servers on all the computers, if we have a local installation of Sage. To start the notebook server just type + +.. L7 :: notebook() +.. R7 + This will start the Sage Notebook server. If we are starting the notebook server for the first time, we are prompted to enter the password for the admin. Type the password and make a note of it. @@ -110,18 +137,26 @@ server started and there were no problems. If so, open your browser and in the address bar, type the URL shown in the instructions upon running the notebook command on the sage prompt. +.. R8 + The notebook() command gives an instruction telling Open your web browser to http://localhost:8000. +.. L8 + {{{ Point towards it }}} In our case it is http://localhost:{{{ Tell whatever is shown }}} +.. L9 + {{{ Show the browser with Sage notebook }}} {{{ If you are logged in tell that you are logged in, log out and show what is said above for the login page }}} +.. R9 + If you are not logged in yet, it shows the Notebook home page and textboxes to type the username and the password. You can use the username 'admin' and the password you gave while starting the notebook @@ -133,13 +168,21 @@ admin page. A notebook can contain a collection of Sage Notebook worksheets. Worksheet is basically a working area. This is where we enter all the Sage commands on the notebook. +.. L10 + {{{ Point at the links on the top of the page }}} +.. R10 + The admin page lists all the worksheets created. On the topmost part of this page we have the links to various pages. +.. L11 + {{{ Point at the links as they are described }}} +.. R11 + The home link takes us to the admin home page. The published link takes us to the page which lists all the published worksheets. The log link has the complete log of all the actions we did on the @@ -151,10 +194,16 @@ offline reference and this help link is the way to get into it. Then we can report bugs about Sage by clicking on Report a Problem link and there is a link to sign out of the notebook. +.. R12 + We can create a new worksheet by clicking New Worksheet link +.. L12 + {{{ Click on the link }}} +.. R13 + Sage prompts you for a name for the worksheet. Let us name the worksheet as 'nbtutorial'. Now we have our first worksheet which is empty. @@ -163,53 +212,85 @@ A worksheet will contain a collection of cells. Every Sage command must be entered in this cell.A cell is equivalent to the prompt on console. When we create a new worksheet, to start with we will have one empty cell. Let us try out some math here + +.. L13 + +.. L14 :: 2 + 2 57.1 ^ 100 +.. R14 + The cap operator is used for exponentiation. If you observed carefully, we typed two commands but the output of only last command was displayed. By default each cell displays the result of only the last operation. We have to use print statement to display all the results we want to be displayed. +.. R15 + Now to perform more operations, we want more cells. So how do we create a new cell? It is very simple. As we hover our mouse above or below the existing cells we see a blue line, by clicking on this new line we can create a new cell. +.. L15 + {{{ Click on the link }}} +.. R16 + We have a cell, we have typed some commands in it, but how do we evaluate that cell? Pressing Shift along with Enter evaluates the cell. Alternatively we can also click on the evaluate link to evaluate the cell +.. L16 + {{{ Evaluate the cell and demonstrate for both methods separately }}} :: matrix([[1,2], [3,4]])^(-1) +.. R17 + After we create many cells, we may want to move between the cells. To move between the cells use Up and Down arrow keys. Also clicking on the cell will let you edit that particular cell. +.. L17 + {{{ Move between two cells created }}} +.. R18 + To delete a cell, clear the contents of the cell and hit backspace +.. L18 + {{{ Clear and demonstrate deleting the cell }}} +.. R19 + If you want to add annotations in the worksheet itself, on the blue line that appears on hovering the mouse around the cell, Hold Shift and click on the line. This creates a What You See Is What You Get cell. +.. L19 + {{{ Create a HTML editable cell }}} +.. R20 + We can make our text here. We can make it bold, Italics, we can create bulleted and enumerated lists in this area + +.. L20 + +{{{ Type in the editable cell }}} :: This text contains both the **bold** text and also *italicised* @@ -221,104 +302,161 @@ can create bulleted and enumerated lists in this area 1. Item 1 2. Item 2 +.. R21 + In the same cell we can display typeset math using the LaTeX like syntax + +.. L21 :: $\int_0^\infty e^{-x} \, dx$ +.. R22 + We enclose the math to be typeset within $ and $ or $$ and $$ as in LaTeX. We can also obtain help for a particular Sage command or function within the worksheet itself by using a question mark following the command + +.. L22 :: sin? +.. R23 + Evaluating this cell gives me the entire help for the sine function inline on the worksheet itself. Similarly we can also look at the source code of each command or function using double question mark + +.. L23 :: matrix?? +.. R24 + Sage notebook also provides the feature for autocompletion. To autocomplete a command type first few unique characters and hit tab key + +.. L24 :: sudo<tab> +.. R25 + To see all the commands starting with a specific name type those characters and hit tab + +.. L25 :: plo<tab> +.. R26 + To list all the methods that are available for a certain variable or a datatype, we can use the variable name followed by the dot to access the methods available on it and then hit tab + +.. L26 :: s = 'Hello' s.rep<tab> +.. R27 + The output produced by each cell can be one of the three states. It can be either the full output, or truncated output or hidden output. The output area will display the error, if the Sage code we wrote in the cell did not successfully execute + +.. L27 :: a, b = 10 +.. L28 + {{{ Show the three states }}} +.. R28 + The default output we obtained now is a truncated output. Clicking at the left of the output area when the mouse pointer turns to hand gives us the full output, clicking again makes the output hidden and it cycles. +.. R29 + Lastly, Sage supports a variety of languages and each cell on the worksheet can contain code written in a specific language. It is possible to instruct Sage to interpret the code in the language we have written. This can be done by putting percentage sign(%) followed by the name of the language. For example, to interpret the cell as Python code we put as the first line in the cell. + +.. L29 :: %python +.. R30 + Similarly we have: %sh for shell scripting, %fortran for Fortran, %gap for GAP and so on. Let us see how this works. Say I have an integer. The type of the integer in default Sage mode is +.. L30 :: a = 1 type(a) +.. L31 + {{{ Read the output }}} +.. R31 + Output: <type 'sage.rings.integer.Integer'> +.. R32 + We see that Integers are Sage Integers. Now let us put %python as the first line of the cell and execute the same code snippet + +.. L32 :: %python a = 1 type(a) +.. L33 + {{{ Read the output }}} +.. R33 + Output: <type 'int'> Now we see that the integer is a Python integer. Why? Because now we instructed Sage to interpret that cell as Python code. +.. L34 + +{{{ Show summary slide }}} + +.. R34 + This brings us to the end of this tutorial.In thus tutorial, we have learnt to, @@ -334,8 +472,12 @@ we have learnt to, #. Use tab completions. #. Embed code of other scripting languages in the cells. +.. L35 + {{{Show self assessment questions slide}}} +.. R35 + Here are some self assessment questions for you to solve 1. Each cell in a sage worksheet displays the result of only the last @@ -348,9 +490,12 @@ Here are some self assessment questions for you to solve - Control key along with enter key - Alt key along with enter key +.. L36 {{{solution of self assessment questions on slide}}} +.. R36 + And the answers, 1. True.By default each cell displays the result of only the last @@ -358,7 +503,10 @@ And the answers, 2. Pressing Shift along with Enter evaluates the cell. +.. L37 + {{{ Show the Thankyou slide }}} +.. R37 Hope you have enjoyed This tutorial and found it useful. Thank you! |