merge

README.do.txt

@@ -9,10 +9,10 @@ Pysketcher can typically be used to draw figures like
 FIGURE: [doc/src/tut/fig-tut/wheel_on_inclined_plane, width=600 frac=0.6]
 
 Such figures can easily be *interactively* made using a lot of drawing
-programs.  A Pysketcher figure, however, is defined in terms of
+programs.  A Pysketcher figure, however, is defined trough
 computer code. This gives a great advantage: geometric features can be
-parameterized in term of variables. Geometric variations are then
-trivially generated, and complicated figures can be built as a
+parameterized in terms of variables. Geometric variations are then
+trivially generated. Also, complicated figures can be built as a
 hierarchy of simpler elements.  The figure can easily be made to move
 according to, e.g., a solution of a differential equation.
 
@@ -40,8 +40,8 @@ FIGURE: [http://hplgit.github.io/bumpy/doc/src/mov-bumpy/m2_k1_5_b0_2/tmp_frame_
 
 ===== Tutorial =====
 
-For an introduction to Pysketcher, see the tutorial in "HTML": "http://hplgit.github.io/pysketcher/doc/pub/pysketcher.html", "Sphinx": "http://hplgit.github.io/pysketcher/doc/pub/html/index.html", or "PDF": "http://hplgit/github.io/pysketcher/doc/pub/pysketcher.pdf" format (or a simplified version of
-the tutorial in Chapter 9 in "A Primer on Scientific Programming with Python": "http://www.amazon.com/Scientific-Programming-Computational-Science-Engineering/dp/3642549586/ref=sr_1_2?s=books&ie=UTF8&qid=1407225588&sr=1-2&keywords=langtangen", by H. P. Langtangen, Springer, 2014).
+For an introduction to Pysketcher, see the tutorial in "HTML": "http://hplgit.github.io/pysketcher/doc/pub/tutorial/pysketcher.html", "Sphinx": "http://hplgit.github.io/pysketcher/doc/pub/tutorial/html/index.html", or "PDF": "http://hplgit/github.io/pysketcher/doc/pub/tutorial/pysketcher.pdf" format (or a simplified version of
+the tutorial in Chapter 9 in "A Primer on Scientific Programming with Python": "http://www.amazon.com/Scientific-Programming-Computational-Science-Engineering/dp/3642549586/ref=sr_1_2?s=books&ie=UTF8&qid=1407225588&sr=1-2&keywords=langtangen", 4th edition, by H. P. Langtangen, Springer, 2014).
 
 ===== Examples =====
 
@@ -49,21 +49,32 @@ See the `examples` directory for some examples beyond the more basic
 ones in the tutorial.
 For example, a pendulum and its body diagram,
 
-FIGURE: [examples/pendulum2, width=800 frac=1]
+FIGURE: [fig/pendulum2, width=800 frac=1]
 
 can be created by the program "`examples/pendulum.py`": "https://github.com/hplgit/pysketcher/tree/master/examples/pendulum.py".
 
+Here is an illustration of the idea of numerical integration:
+
+FIGURE: [fig/integral_noncomic_strip, width=800 frac=1]
+
+As shown in the figure-generating program "`examples/integral_comic_strip.py`": "https://github.com/hplgit/pysketcher/tree/master/examples/integral_comic_strip.py",
+this illustration can easily be turned into an "XKCD": "http://xkcd.com" type of comic strip:
+
+FIGURE: [fig/integral_comic_strip, width=800 frac=1]
+
 ===== Technology =====
 
-Pysketcher applies Matplotlib to make the drawings, but it is quite
-easy to replace the backend `MatplotlibDraw.py` by similar code
-utilizing TikZ or another plotting package. The Pysketcher software is
-a thin layer basically constructing a tree structure of elements in
-the sketch. A lot of classes are offered for different type of basic
-elements, such as Circle, Rectangle, Text, Text with arrow, Force,
-arbitrary curve, etc.  Complicated figures can be created by sticking
-one figure into another (i.e., hierarchical building of figures by
-sticking one tree structure into another).
+Pysketcher applies Matplotlib to make the drawings, but it should be quite
+straightforward to replace the backend `MatplotlibDraw.py` by similar code
+utilizing TikZ or another plotting package.
+
+The core of the Pysketcher software is a thin layer basically
+constructing a tree structure of elements in the sketch. A lot of
+classes are offered for different type of basic elements, such as
+Circle, Rectangle, Text, Text with arrow, Force, arbitrary curve, etc.
+Complicated figures can be created by sticking one figure into another
+(i.e., hierarchical building of figures by sticking one tree structure
+into another).
 
 ===== Install =====
 

README.md

@@ -10,10 +10,10 @@ Pysketcher can typically be used to draw figures like
 ![](doc/src/tut/fig-tut/wheel_on_inclined_plane.png)
 
 Such figures can easily be *interactively* made using a lot of drawing
-programs.  A Pysketcher figure, however, is defined in terms of
+programs.  A Pysketcher figure, however, is defined trough
 computer code. This gives a great advantage: geometric features can be
-parameterized in term of variables. Geometric variations are then
-trivially generated, and complicated figures can be built as a
+parameterized in terms of variables. Geometric variations are then
+trivially generated. Also, complicated figures can be built as a
 hierarchy of simpler elements.  The figure can easily be made to move
 according to, e.g., a solution of a differential equation.
 
@@ -44,8 +44,8 @@ other objects in the vehicle. [View animation](http://hplgit.github.io/bumpy/doc
 
 ### Tutorial
 
-For an introduction to Pysketcher, see the tutorial in [HTML](http://hplgit.github.io/pysketcher/doc/pub/pysketcher.html), [Sphinx](http://hplgit.github.io/pysketcher/doc/pub/html/index.html), or [PDF](http://hplgit/github.io/pysketcher/doc/pub/pysketcher.pdf) format (or a simplified version of
-the tutorial in Chapter 9 in [A Primer on Scientific Programming with Python](http://www.amazon.com/Scientific-Programming-Computational-Science-Engineering/dp/3642549586/ref=sr_1_2?s=books&ie=UTF8&qid=1407225588&sr=1-2&keywords=langtangen), by H. P. Langtangen, Springer, 2014).
+For an introduction to Pysketcher, see the tutorial in [HTML](http://hplgit.github.io/pysketcher/doc/pub/tutorial/pysketcher.html), [Sphinx](http://hplgit.github.io/pysketcher/doc/pub/tutorial/html/index.html), or [PDF](http://hplgit/github.io/pysketcher/doc/pub/tutorial/pysketcher.pdf) format (or a simplified version of
+the tutorial in Chapter 9 in [A Primer on Scientific Programming with Python](http://www.amazon.com/Scientific-Programming-Computational-Science-Engineering/dp/3642549586/ref=sr_1_2?s=books&ie=UTF8&qid=1407225588&sr=1-2&keywords=langtangen), 4th edition, by H. P. Langtangen, Springer, 2014).
 
 ### Examples
 
@@ -53,22 +53,35 @@ See the `examples` directory for some examples beyond the more basic
 ones in the tutorial.
 For example, a pendulum and its body diagram,
 
-<!-- <img src="examples/pendulum2.png" width=800> -->
-![](examples/pendulum2.png)
+<!-- <img src="fig/pendulum2.png" width=800> -->
+![](fig/pendulum2.png)
 
 can be created by the program [`examples/pendulum.py`](https://github.com/hplgit/pysketcher/tree/master/examples/pendulum.py).
 
+Here is an illustration of the idea of numerical integration:
+
+<!-- <img src="fig/integral_noncomic_strip.png" width=800> -->
+![](fig/integral_noncomic_strip.png)
+
+As shown in the figure-generating program [`examples/integral_comic_strip.py`](https://github.com/hplgit/pysketcher/tree/master/examples/integral_comic_strip.py),
+this illustration can easily be turned into an [XKCD](http://xkcd.com) type of comic strip:
+
+<!-- <img src="fig/integral_comic_strip.png" width=800> -->
+![](fig/integral_comic_strip.png)
+
 ### Technology
 
-Pysketcher applies Matplotlib to make the drawings, but it is quite
-easy to replace the backend `MatplotlibDraw.py` by similar code
-utilizing TikZ or another plotting package. The Pysketcher software is
-a thin layer basically constructing a tree structure of elements in
-the sketch. A lot of classes are offered for different type of basic
-elements, such as Circle, Rectangle, Text, Text with arrow, Force,
-arbitrary curve, etc.  Complicated figures can be created by sticking
-one figure into another (i.e., hierarchical building of figures by
-sticking one tree structure into another).
+Pysketcher applies Matplotlib to make the drawings, but it should be quite
+straightforward to replace the backend `MatplotlibDraw.py` by similar code
+utilizing TikZ or another plotting package.
+
+The core of the Pysketcher software is a thin layer basically
+constructing a tree structure of elements in the sketch. A lot of
+classes are offered for different type of basic elements, such as
+Circle, Rectangle, Text, Text with arrow, Force, arbitrary curve, etc.
+Complicated figures can be created by sticking one figure into another
+(i.e., hierarchical building of figures by sticking one tree structure
+into another).
 
 ### Install
 

examples/integral.py

@@ -1,7 +1,7 @@
 """Comic strip for illustrating numerical integration."""
 
 from pysketcher import *
-xdcd = True
+xkcd = True  # True: XKCD copic strip, False: ordinary Matplotlib figure
 
 def f(x):
     return 3*np.exp(-x**4)

examples/osc1.py

@@ -1,3 +1,5 @@
+"""Draw mechanical vibration system."""
+
 from pysketcher import *
 
 L = 12.
@@ -37,16 +39,16 @@ wheel2.translate(point(2*H, 0))
 
 fontsize = 18
 text_m = Text('$m$', (2*H, H+2*H), fontsize=fontsize)
-text_kx = Text('$kx$', (-L/2, H+4*H), fontsize=fontsize)
-text_bv = Text('$b\dot x$', (-L/2, H), fontsize=fontsize)
-x_axis = Axis((2*H, L), H, '$x(t)$', fontsize=fontsize,
+text_ku = Text('$ku$', (-L/2, H+4*H), fontsize=fontsize)
+text_bv = Text("$bu'$", (-L/2, H), fontsize=fontsize)
+x_axis = Axis((2*H, L), H, '$u(t)$', fontsize=fontsize,
               label_spacing=(0.04, -0.01))
 x_axis_start = Line((2*H, L-H/4), (2*H, L+H/4)).set_linewidth(4)
 
 fig = Composition({
     'spring': s, 'mass': M, 'left wall': left_wall,
     'ground': ground, 'wheel1': wheel1, 'wheel2': wheel2,
-    'text_m': text_m, 'text_kx': text_kx,
+    'text_m': text_m, 'text_ku': text_ku,
     'x_axis': x_axis, 'x_axis_start': x_axis_start})
 
 fig.draw()
@@ -66,17 +68,17 @@ drawing_tool.savefig('tmp_oscillator')
 
 drawing_tool.erase()
 
-text_kx = Text('$s(u)$', (-L/2, H+4*H), fontsize=fontsize)
-text_bv = Text('$f(\dot u)$', (-L/2, H), fontsize=fontsize)
+text_ku = Text('$ku$', (-L/2, H+4*H), fontsize=fontsize)
+text_bv = Text("$bu'$", (-L/2, H), fontsize=fontsize)
 x_axis = Axis((2*H, L), H, '$u(t)$', fontsize=fontsize,
               label_spacing=(0.04, -0.01))
 F_force = Force((4*H, H+2*H), (4*H+H, H+2*H), '$F(t)$',
-                text_spacing=(0.035, -0.01), text_pos='end', fontsize=fontsize)
-fig['text_kx'] = text_kx
+                text_spacing=(0.057, -0.007), text_alignment='left', fontsize=fontsize)
+fig['text_ku'] = text_ku
 fig['text_bv'] = text_bv
 fig['x_axis'] = x_axis
 fig['F_force'] = F_force
 fig.draw()
 drawing_tool.savefig('tmp_oscillator_general')
 
-input()
+raw_input()

examples/osc2.py

@@ -1,4 +1,4 @@
-"""As osc.py, but without wheels."""
+"""As oscillator_sketch1.py, but without wheels."""
 from pysketcher import *
 
 L = 12.
@@ -36,7 +36,7 @@ ground = Wall(x=[-L/2,L], y=[H,H], thickness=-H/10)
 fontsize = 18
 text_m = Text('$m$', (2*H, H+2*H), fontsize=fontsize)
 text_kx = Text('$s(u)$', (-L/2, H+4*H), fontsize=fontsize)
-text_bv = Text('$f(u)$', (-L/2, H), fontsize=fontsize)
+text_bv = Text('$f(u)$', (-1.25*L/2, H), fontsize=fontsize)
 x_axis = Axis((2*H, L), H, '$u(t)$', fontsize=fontsize,
               label_spacing=(0.04, -0.01))
 x_axis_start = Line((2*H, L-H/4), (2*H, L+H/4)).set_linewidth(4)
@@ -65,7 +65,7 @@ drawing_tool.savefig('tmp_oscillator2')
 drawing_tool.erase()
 
 F_force = Force((4*H, H+2*H), (4*H+H, H+2*H), '$F(t)$',
-                text_spacing=(0.035, -0.01), text_pos='end', fontsize=fontsize)
+                text_spacing=(0.057, -0.007), text_alignment='left', fontsize=fontsize)
 fig['F_force'] = F_force
 fig.draw()
 drawing_tool.savefig('tmp_oscillator2_force')

pysketcher/MatplotlibDraw.py

@@ -390,7 +390,7 @@ self.ax.plot(x, y, linewidth=%d, color='gray',
 
 
     def text(self, text, position, alignment='center', fontsize=0,
-             arrow_tip=None):
+             arrow_tip=None, bgcolor=None, fgcolor=None, fontfamily=None):
         """
         Write `text` string at a position (centered, left, right - according
         to the `alignment` string). `position` is a point in the coordinate
@@ -409,10 +409,18 @@ self.ax.plot(x, y, linewidth=%d, color='gray',
                     'No self.fontsize attribute to be used when text(...)\n'
                     'is called with fontsize=0. Call set_fontsize method.')
 
+        kwargs = {}
+        if fontfamily is not None:
+            kwargs['family'] = fontfamily
+        if bgcolor is not None:
+            kwargs['backgroundcolor'] = bgcolor
+        if fgcolor is not None:
+            kwargs['color'] = fgcolor
+
         x, y = position
         if arrow_tip is None:
             self.ax.text(x, y, text, horizontalalignment=alignment,
-                         fontsize=fontsize)
+                         fontsize=fontsize, **kwargs)
             if self.instruction_file:
                 self.instruction_file.write("""\
 ax.text(%g, %g, %s,

pysketcher/shapes.py

@@ -80,7 +80,7 @@ def _is_sequence(seq, length=None,
             if length == len(seq):
                 return True
             elif error_message:
-                raise TypeError('%s is %s; must be %s of length %d' %
+                raise TypeError('sequence %s is not a sequence but %s; must be %s of length %d' %
                             (str(seq), type(seq),
                             ', '.join([str(t) for t in legal_types]),
                              len(seq)))
@@ -89,7 +89,7 @@ def _is_sequence(seq, length=None,
         else:
             return True
     elif error_message:
-        raise TypeError('%s is %s, %s; must be %s' %
+        raise TypeError('sequence %s is not a sequence but %s, %s; must be %s' %
                         (str(seq), seq.__class__.__name__, type(seq),
                         ','.join([str(t)[5:-1] for t in legal_types])))
     else:
@@ -1303,19 +1303,29 @@ class Text(Point):
     'center'; if 'left', the text starts at `position`, and if
     'right', the right and of the text is located at `position`.
     """
-    def __init__(self, text, position, alignment='center', fontsize=0):
+    def __init__(self, text, position, alignment='center', fontsize=0,
+                 bgcolor=None, fgcolor=None, fontfamily=None):
+        """
+        fontfamily can be (e.g.) 'serif' or 'monospace' (for code!).
+        """
         is_sequence(position)
         is_sequence(position, length=2, can_be_None=True)
         self.text = text
         self.position = position
         self.alignment = alignment
         self.fontsize = fontsize
+        self.bgcolor = bgcolor
+        self.fgcolor = fgcolor
+        self.fontfamily = fontfamily
         Point.__init__(self, position[0], position[1])
         #no need for self.shapes here
 
     def draw(self):
-        drawing_tool.text(self.text, (self.x, self.y),
-                          self.alignment, self.fontsize)
+        drawing_tool.text(
+            self.text, (self.x, self.y),
+            self.alignment, self.fontsize,
+            arrow_tip=None, bgcolor=self.bgcolor, fgcolor=self.fgcolor,
+            fontfamily=self.fontfamily)
 
     def __str__(self):
         return 'text "%s" at (%g,%g)' % (self.text, self.x, self.y)
@@ -1337,9 +1347,13 @@ class Text_wArrow(Text):
         Text.__init__(self, text, position, alignment, fontsize)
 
     def draw(self):
-        drawing_tool.text(self.text, self.position,
-                          self.alignment, self.fontsize,
-                          self.arrow_tip)
+        drawing_tool.text(
+            self.text, self.position,
+            self.alignment, self.fontsize,
+            arrow_tip=self.arrow_tip,
+            bgcolor=self.bgcolor, fgcolor=self.fgcolor,
+            fontfamily=self.fontfamily)
+
     def __str__(self):
         return 'annotation "%s" at (%g,%g) with arrow to (%g,%g)' % \
                (self.text, self.x, self.y,