Issue 1196: improve our examples
http://code.google.com/p/sympy/issues/detail?id=1196

Comment #4 by andy.terrel:
So I'm just going to put up the README and the division of files I propose  
here, since a patch would basically
be all the files moved around.

I think there should be quite a few changes with these files but for now I  
just want to see if the structure is
good.  I'll start messing with files later.

Additionally some examples should probably be removed, such as t.py, and  
print_pygame.py

-- Andy

-------
README

This directory contains SymPy example programs.

-------------------------------------------------------------------------------
DIRECTORY STRUCTURE

The examples are broken up into three categories based on difficulty of both
the mathematics and programming concepts.  They roughly follow the following
guide:

beginner :
   Simple examples appropriate for first steps in using SymPy, for someone
   with little or no programming experience.

intermediate :
   Demonstrations of more complex mathematical concepts, but still for
   someone with little programming experience.

advanced :
   Larger demonstrations of advanced mathematical topics.

-------------------------------------------------------------------------------
RUNNING EXAMPLES

To run the examples one needs to have Python version >= 2.4 installed.  Each
example can be run from the command line python and the name of the example:

   [EMAIL PROTECTED]:~/sympy/examples$ python beginner/basic.py
   (3*a*b**2)**c

All the working examples can be run by executing the "./all" script, if an
example is known to be broken it will be commented out in this script.

---------
all.py

#! /bin/bash
# Executes all examples, that are working (mainly for testing purposes).
#
# Usage:
#
# When all examples run:
#   $ ./all > out
#   $
#
# When some examples fail:
#   $ ./all > out
#   Traceback (most recent call last):
#     File "./limits_examples.py", line 17, in ?
#   [...]
#   $
#
# Obviously, we want to achieve the first result.

# The commented out examples don't run

# Beginner Examples
./beginner/basic.py
./beginner/differentiation.py
./beginner/expansion.py
./beginner/functions.py
./beginner/limits_examples.py
#./beginner/plotting_nice_plot.py
./beginner/precision.py
./beginner/print_pretty.py
./beginner/series.py
./beginner/substitution.py
./beginner/t.py

# Intermediate Examples
./intermediate/differential_equations.py
#./intermediate/mplot2d.py
#./intermediate/mplot3d.py
#./intermediate/print_gtk.py
#./intermediate/print_pygame.py
./intermediate/trees.py
./intermediate/vandermonde.py

# Advanced Examples
./advanced/fem_test.py
./advanced/gibbs_phenomenon.py
#./advanced/pidigits.py
#./advanced/plotting.py
#./advanced/qft.py
./advanced/relativity.py
#./advanced/tensors.py






-- 
You received this message because you are listed in the owner
or CC fields of this issue, or because you starred this issue.
You may adjust your issue notification preferences at:
http://code.google.com/hosting/settings

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"sympy-issues" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/sympy-issues?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to