File: Tioga_README

package info (click to toggle)
libtioga-ruby 1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 9,956 kB
  • ctags: 3,257
  • sloc: ansic: 31,801; ruby: 16,346; sh: 172; makefile: 114
file content (491 lines) | stat: -rw-r--r-- 21,303 bytes parent folder | download
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
This is the README for the Tioga kernel, version 1.8, April 4, 2008.

    Copyright (C) 2005, 2006, 2007, 2008  Bill Paxton
    Copyright (C) 2007, 2008 Vincent Fourmond, Taro Sato
    
    This file is part of Tioga.
    
    Tioga is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Library Public License as published
    by the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    
    Tioga is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Library General Public License for more details.
    
    You should have received a copy of the GNU Library General Public License
    along with Tioga; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

<< What's new >>

    Version 1.8 is essentially a cleanup/bug fix release. Tioga now compiles
with hardly any warnings, thanks to the work by Taro Sato. show_axis can now
take a hash instead of a simple location, and can draw axes basically
anywhere. See the axes_fun function in samples/plots/plots.rb and
show_axis documentation. Few bugs were fixed, in particular the
position of ticks with ticks_inside/ticks_outside, and the
installation via Rubygems which was broken for such a long time we are
ashamed of it. 


<< Quick Installation of Tioga >>

    Are you feeling lucky?  If so, try QUICK_INSTALL.  This simply does
the steps for you that are described below.  The install needs to copy some
files to the ruby directory.  On the Mac, this probably means you need to do
the whole thing with a 'sudo'.  For Linux, you may have to become root.
Once you've taken care of that, just run the QUICK_INSTALL script and
keep your fingers crossed.

    You now have the option to run HOME_INSTALL instead, which will
install the files to your home directory (no root privileges
needed). You just need to set your RUBYLIB environment variable as
reminded at the end of the file.

    Please check that there are 0 failures and 0 errors at the end of the test.
Then, in your favorite PDF previewer, open the newly created 'tests/Icon_Test.pdf'
and compare it to the prebuilt 'samples/Icon.pdf'.  They should be very similar!
If it all seems to be working, go directly to the << Documentation >> section below.


<< Step-by-Step Installation >>

    To get Tioga running, you need to have a working Ruby, a C compiler,
make, and pdflaxtex.  Assuming you've got all that (more later if you don't),
connect to the Tioga directory that you just unpacked and do the following:

  [ this has been changed, be careful ! ]

    cd split 
    ruby extconf.rb
    make
    make install

This creates the Makefile, runs it, and finally does the actual
installation.  The "make install" needs to copy some files to the ruby directory.
On the Mac, this probably means you need to do the whole thing inside a 'sudo'.
For Linux, you may have to become root.

Note that on Linux, the make will compile all the source files.  On the Mac,
the tar file includes precompiled versions of everything, so the make won't
have anything to do.  That's okay.  Do the whole sequence anyway just to be safe.

    You now have another option to install: if you replace the line
    ruby extconf.rb
with 
    ruby extconf.rb --home
it will install the files to your home directory, namely ~/lib/ruby. You don't need root 
privileges to do that, but make sure that you set RUBYLIB=~/lib/ruby somewhere, so that ruby 
can find it.




<< Checking The Installation >>

    To make sure at least something works of out the newly installed stuff,
change directory to your new Tioga folder.  Then enter this to the shell:

    cd tests
    ruby ts_Tioga.rb
    
This should produce something like the following if the install worked:

	Loaded suite ts_Tioga
	Started
	.....................................................
	compressed from 0 to 8
	compressed from 13 to 21
	compressed from 70 to 69
	compressed from 3631 to 1642
	.pdflatex -interaction nonstopmode Icon_Test.tex > pdflatex.log
 
 
 
	>>> NOTE: please look at tests/Icon_Test.pdf and compare it to samples/Icon.pdf
	.
	Finished in 0.501211 seconds.

	55 tests, 647 assertions, 0 failures, 0 errors

[the numbers here are not up-to-date, tests are added everytime a feature is added, so it 
is likely the numbers you see are greater - it means we're actually working ;-) !]

These tests ensure that Tioga is accessible and that some of the basic stuff is working.
Don't skip the visual check of the newly created file 'tests/Icon_Test.pdf'.
If that's ok, there's a good chance your installation is up and running.

The next step is to do the tutorial found in the documentation.



<< Tutorial >>

    Once you have Tioga installed, the on-line tutorial will help you
get started using it.
    
http://theory.kitp.ucsb.edu/~paxton/tioga_doc/classes/Tioga/Tutorial.html


<< Documentation >>

    Visit this website to access the documentation:
    
        http://theory.kitp.ucsb.edu/~paxton/tioga_doc/index.html

If for some reason that link isn't working, go to my website,

        http://theory.kitp.ucsb.edu/~paxton

and check there for a new link to the Tioga stuff.

    Try to get by with the on-line documentation, but if you really
have a need to rebuild the documentation using Rdoc, I've
included a .document file in the release folder.  However, all
the figures have direct links to jpegs on my website, so you'll
either have to live with that, or do a bunch of edits.  Send me
an email if you'd like a tar file of the images.


<< Open Source >>

    You are welcome to take the Tioga source and do what you want with it
(within the bounds of the GNU license of course).  But don't even think about
asking for support from me for debugging your new stuff!  I have enough trouble
with my own bugs to keep me busy endlessly!  But if it looks like a bug in Tioga,
please do let me know so I can try to fix it.  Or even better, let me know
the fix along with the bug!


----------------------------------

For more, visit my website:  http://theory.kitp.ucsb.edu/~paxton

Best wishes,
Bill Paxton




	
	
	
<< What's old >>

Here are the old release messages:


--------------------------

    Version 1.7 adds an option in legends for markers without any line;
just call save_legend_info with 'line_type' => 'None' in addition to
the marker information.  It is also now possible to give a 'legend' argument
to show_marker.  The value of the arg can be either a legend dictionary
or simply the legend text in which case defaults will be supplied for
the rest.  There is an example of this in samples/plots.rb
in the Legend_Outside figure.

    It saw a very significant improvement in that you can now query
the exact size of a text typeset by LaTeX, with the function text_size. Please
have a look at its documentation, and at the Text_size and 
Text_size_with_rotation samples in samples/figures/figures.rb.

    The code base was quite moved around so as to facilitate work on a 
Python version that would share as much code as possible with the Ruby one;
this should not bring user-visible changes (apart, maybe, from compilation
problems, but we hope not).

    Some bug fixes, including potential stack overflows (unprotected
snprintfs), and some new methods of Function. Dvector.fancy_read has been
reimplemented in C and benchmarked: it should be around three times faster
than before.

    Code should now compile cleanly with Ruby 1.9.




--------------------------

   Version 1.6 adds numeric label "frequency" and "phase" attributes for
both axes.  Previously Tioga assumed that every major tick mark got a numeric
label.  Now the i'th major tick on the axis gets a label only if
mod(i+j,k)==0 where j is the phase and k is the frequency.  The default
frequency is naturally 1 so that every major tick gets a label.
The full names for these attributes are xaxis_numeric_label_frequency,
xaxis_numeric_label_phase, and similar for yaxis.

--------------------------

	Version 1.5 is mainly Vincent's work, so my part of this release message
will be short.  Remember how I killed off the Mac GUI last time?  Turns out there
was one user who couldn't live without it -- me!  So it's back, but I'm still not
making any promises about keeping it alive if Apple does something stupid in
coming releases.  If you're interested in playing with it in spite of that warning,
it's available from my website (http://theory.kitp.ucsb.edu/~paxton/Tioga-1.5.dmg).

	Cheers, Bill

	[Vincent] Version 1.5 has seen a not-so-s�mall change inthe structure of the 
tutorial, which now has local links to images. So the images are now included in the
tarball (though the -without-images don't have them, for those who have sparse 
disk space or bandwidth). To get a local copy of the tutorial, just run rdoc 
and then link doc/images to images using the following commands:

cd doc; ln -s ../images .

There are just a few new functions this time: 
  * FigureMaker#create_figure_temp_files has been made part of the public 
interface of tioga, it produces only the intermediate pdf and TeX files but 
doesn't run pdflatex (used by ctioga)
  * a Function#derivative method has been added, that does what you think it 
does.

The C code has been heavily tweaked to prevent segfaults on some 
architectures/distributions, and some samples were added, notably one for 
insets (I'll let you find it !).

	Cheers, Vincent

--------------------------

	Version 1.4 is a major overhaul with particular emphasis on the tioga user interface.
Please take a moment to go through the new section of the tutorial titled, CommandLine.
It gives a detailed discussion of the new tioga command line interface that replaces
irb_tioga and the old mac gui.  There is a also new small drag-and-drop application for the Mac
called "Tioga Droplet" that takes any file dropped on it and sends it to the new tioga
command line interface to have a portfolio created and displayed.  There
is also a browser-based viewer called Vtioga that JJ Fleck has developed that uses
command line tioga to create pdfs, converts them to png's, and displays them in a
browser page using Ruby on Rails.  And Vincent Fourmond has of course been continuing his
development of Ctioga.  So there are now several nice options available for tioga user
interfaces.  [BTW: The old mac gui for tioga is now an orphan; I've decided I can't commit to
giving it the amount of attention it seems to need to stay healthy!  The current upheaval
in the user interface area is a result of my decision that things needed to get simpler.
If you've become hopelessly addicted to the old mac gui, I'll happily let you adopt it.
Just let me know, and it's yours to maintain and develop as long as your sanity lasts.]

	If you take a look in tioga/samples/plots, you will find a new item: plot_styles.rb.
Do you like to use a sans-serif font for your plots?  Then 'require plot_styles.rb' in your plot file,
'include MyPlotStyles' in your plot class (the module defined in plot_styles.rb), and call the 'sans_serif_style' method at the beginning of your plot definition 
(or from your enter_page function, or from your
plot class initialization method).  Curious about what tioga attributes there are for
dealing with the appearance of plots?  Scan through the set_default_plot_style method
in plot_styles.rb.  Want a style that's not in plot_styles.rb?  Great!  Write it yourself,
and share it with the rest of us by sending a message to tioga-users! 

Additionnally, some more classical functionalities have been added: 
  * show_arrow now allows to specify a 'line_style' and justification for
  the markers, see the plot samples/figures/figures.rb: Arrows_second_take
  * a function Dvector.write has been added that does exactly the
  reverse of Dvector.(fancy_)read.

--------------------------	

	  Version 1.3.1 is as usual a bug-fix release, although bugs
were not that obvious this time. Among other things,
  * it fixes some troubles with IRB and the Mac GUI
  * it fixes the use of Tioga custom colors in the LaTeX materials,
  such as in one of the figures in samples/figures/figures.rb. 
  * quite a bit of code cleaning
  * some documentation updates
  * and, last but not least, the samples/ directory now contains a shell
  script to create and optionally display all the figures defined in
  one IRB Tioga ruby file. If, say, you can use gv to view PDFs, try
  out the following line:

  cd samples; ./make_plots --viewer gv figures/figures.rb
  
  Enjoy !!

	--Vincent
	
		Vincent has added a #primitive method to Function (during breaks from
writing his thesis).

    	There is a new contour algorithm.  Thank you to Roy Mayfield for telling me about the
Gri contour following routine (http://gri.sourceforge.net/).  Tioga's make_contour method now
uses that as its default;  the previous algorithm, CONREC, is still available as an option.
However, the new one seems superior -- especially if you'd like to be able to fill the contour
rather than simply stroke it.  In addition, you can optionally provide it with a "mask" of flags
indicating which entries in the table are valid for use in forming the contours.  Neat stuff.

--------------------------
	
		Version 1.3.0 will automatically remove the tex temporary files it creates
(unless the autocleanup attribute is set false).  Commands that used to have
"preview" in their names have been renamed to remove it.  For example, the
old tex_preview_fontfamily is now called tex_fontfamily.  (The old names are
actually still around for backward compatibility, but we won't be mentioning
them anymore!)  Some other commands have gone away completely since they 
have been made obsolete by the new approach of page layout using the
enter page function.  As a reminder, here's what I wrote in a recent email 
about the change in my model of what Tioga is really doing:

      In the "old days", I thought of Tioga as producing intermediate files 
      (the *_figure.tex and *_figure.txt files) that would at some later time 
      be combined by TeX to create a figure in a TeX document.  So, in that view, 
      the "final" figure PDF was created by TeX as part of typesetting a document.  
      However, I naturally wanted to see what the figure looked like while I was 
      debugging it, and so there was a "preview" ability in Tioga as well.  And 
      before long it became clear that I was looking at things in the "wrong" way.

      So there was a reversal in my image, and now I think of the process as Tioga 
      producing the final PDF for the figure and, as part of that, calling TeX as 
      a subroutine to get the job done.  Then the figure PDF can be used however 
      you wish -- as part of a TeX document of course, but for anything else as 
      well.  There is no longer any need for a "preview" and the *_figure files 
      can be deleted immediately since they're now just temporaries created to 
      drive TeX.

      There wasn't too much needed to provide better support for this new view 
      of things.  Mainly, you need to be able to specify exact sizes for figure 
      and fonts.

      Now for specifics.  Please take a quick look at tioga samples/plots/plots.rb 
      that is part of the download.   At the end of the initialize routine, at line 63, 
      there is a new addition:

              t.def_enter_page_function { enter_page }

      This tells tioga that whenever it is about to create a new PDF page, it should 
      call the 'enter_page' method which is defined in the next few lines of the file:

          def enter_page
              t.page_setup(11*72/2,8.5*72/2)
              t.set_frame_sides(0.15,0.85,0.85,0.15) # left, right, top, bottom in page coords       
          end

      The page_setup routine takes the desired width and height in "big points" (72 per inch).
      So in this case, the PDF will be 5.5 inches wide and 4.25 inches high.  The set_frame_sides 
      routine takes fractional positions on the page (i.e., page coordinates).  If you wanted 
      to change the fonts, you could do that in the enter_page routine as well by adding a 
      line like this:

              t.set_default_font_size(14)

      I hope this helps to clarify things.

	--Bill

--------------------------

	Version 1.2.1 is as usual a bug-fix release fixing some installation problems...

--------------------------

	Version 1.2.0 brings in a lot of new features. First and most important, we came up with a
proper design for a real-size scheme. Now, you can use the page_setup function to ask Tioga to
produce a preview PDF of the exact size requested, so that you can include the PDF directly in
your documents (not only LaTeX, then). A whole bunch of debugging tools have been added: you can
now set tracing tools with the (enter|exit)_(show_plot|subplot|subfigure) functions. As usual,
there is a whole bunch of small improvements and new functions to Dvector and Function.

--------------------------

	Version 1.1.7 fixes a nasty runtime bug on MacOS X.

--------------------------

	Version 1.1.6 provides marshalling for Dtable and Dvector. You can now use Marshal.dump and
Marshal.load with Dvectors. Dvectors and Function now have a bounds function, which return both the
minima and the maxima. Ruby is no longer complaining about Tioga when used with the -w switch.

--------------------------

	Version 1.1.5 is a bug-fix release - updated to the latest mkmf2.rb to make sure all
necessary files are generated during make.

--------------------------

	Version 1.1.4 is a bug-fix release - a nasty symbol clash was preventing Tioga from running
on MacOS X.3. This should now be fixed. Moreover, the load time should improve a little bit on few 
architectures.

--------------------------

	Version 1.1.3 provides a better integration of output within LaTeX
documents. A tioga.sty file is now available, with many macros for figure
inclusion and color names like the ones provided by Tioga.

	The Dobjects module is proud to announce the birth of the latest
class, Function, which provides basic interpolation and sorting for sets of
X,Y data. Not many features for now, but there's room for plenty more work.

	Dvector provides a few more functions:
		clear?, dirty?, dirty= (to check if a vector has been modified)
		min_gt, max_lt (extrema with conditions)
		set (mass modification of Dvector)

	FigureMaker has now functions for coordinate conversions:
		convert_inches_to_output, convert_output_to_inches,
		convert_mm_to_output, convert_output_to_mm

--------------------------

	Version 1.1.2 provides more complete control over page layout and font
selection.  Here's a list of new features:

		for top-level page layout
			set_device_pagesize(width, height) # measured in tenths of points
			set_A4_portrait, set_A4_landscape
			set_A5_portrait, set_A5_landscape
			set_B5_portrait, set_B5_landscape
			set_JB5_portrait, set_JB5_landscape
			set_USLegal_portrait, set_USLegal_landscape
			set_USLetter_portrait, set_USLetter_landscape
			set_frame_sides(left, right, top, bottom) # sizes in page coords [0..1]

		for TeX preview page and figure size
			tex_preview_paper_width
			tex_preview_paper_height
			tex_preview_hoffset
			tex_preview_voffset
			tex_preview_figure_width
			tex_preview_figure_height

		for TeX preview font selection
			tex_preview_fontsize
			tex_preview_fontfamily
			tex_preview_fontseries
			tex_preview_fontshape

--------------------------

	Version 1.1.1 is the first Tioga to be called a "beta" release.  You can
interpret that anyway you'd like, but to me it means Tioga has been around long
enough and had enough use to justify inviting more folks to give it a try.
The "alpha" label is a warning to "proceed at your own risk", and only brave
souls go ahead when they see that.  I think Tioga has gotten stable enough
that we can drop the "threat level" down a notch.  (Fingers crossed of course!)

--------------------------

	Version 1.1.0 splits off the Dvector & Dtable modules from the FigureMaker so
that they can be used in other packages (Vincent Fourmond both suggested this and
did the work to make it happen).

--------------------------

    Version 1.0.M no longer raises error for calls on 'stroke', 'fill', and such with an empty path.
It has also been reconfigured to support the new Mac GUI which now works with both PowerPC and Intel
processors.

--------------------------

    Version 1.0.L adds 'transparency' as a synonym for (1.0 - opacity).  So
now you can set 'fill_transparency' to 0.3 instead of setting 'fill_opacity'
to 0.7.  I'm sure that makes your day.  The documentation has also been
updated of course.

--------------------------

    Version 1.0.K was Vincent Fourmond's fault!  The same day that J was released,
he sent me an email pointing out an oversight in the legend functionality.
Not only that, he sent along an implementation to fix the problem!  What could I do?
I had to put it in and make a new release.  So thanks to Vincent, you can now include 
markers on the lines in legends.  Details in the new documentation for 'save_legend_info'.