1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# tutorial.rb
module Tioga
=begin rdoc
= Tutorial
This tutorial gives a guided tour through the programs included in the "samples" subfolder
found in the installation folder. It also contains material introducing the command
line interface along with hints and suggestions for using tioga effectively.
By the way, the tutorial assumes you want to use Ruby directly to write the programs that
describe the figures and plots. If instead of that you'd prefer a command-line interface
along the lines of gnuplot, then be sure to read all about {Ctioga}[http://sciyag.rubyforge.org/ctioga/index.html].
Basically, Ctioga writes the ruby program for you, making it easy to do easy plots while still having
the ability to do complex ones by adding options to the command line.
---
The first step in the tutorial is to locate the samples folder and take a look at what's inside.
You should find a +README+ and several subfolders including:
* figures
* plots
* star_history
* star_profile
* zams
The +README+ file basically just directs readers to this documentation. The "figures" subfolder has the most basic stuff.
Next comes "plots" which extends the discussion to the methods
needed to make plots. The final three folders, "star_history", "star_profile", and "zams",
come from my own stellar evolution work. They give "real life"
examples of non-trivial applications.
Here are the sections of the tutorial, in the order they are intended to be read.
DocStructure -- The basic anatomy of a tioga document
CommandLine -- How to run and debug your tioga programs
UsingRuby -- The bare essentials for using ruby for tioga
SimpleFigure -- A first look at a nontrivial tioga figure definition
TextForTeX -- How to Add Packages and How (and How Not) to Enter Text for TeX
Plots -- The extras for making plots
Data -- Tools for reading and manipulating the data for plots
SampledData -- Making plots with a false-color image of sampled data
Animation -- How to create a sequence of PDFs and convert it to a movie
OtherStuff -- A few "real life" examples
Epilog -- "Do it yourself" using the tioga kernel for making figures
=end
module Tutorial
end # module Tutorial
end # module Tioga
|
