README.txt

   1
   2 ============================================================
   3 SympyCore - an efficient pure Python Computer Algebra System
   4 ============================================================
   5
   6 :Authors:
   7
   8   Pearu Peterson <pearu.peterson AT gmail DOT com>
   9
  10   Fredrik Johansson <fredrik.johansson AT gmail DOT com>
  11
  12 :Website:
  13
  14   http://sympycore.googlecode.com/
  15
  16 :License:
  17
  18   New BSD License
  19
  20 History
  21 =======
  22
  23  * Version 0.1 released on February 29, 2008.
  24
  25 Download
  26 ========
  27
  28 The latest release can be downloaded from sympycore website.
  29
  30 The latest development code is available via SVN. To check it out,
  31 run::
  32
  33   svn checkout http://sympycore.googlecode.com/svn/trunk/ sympycore-svn
  34   cd sympycore-svn
  35
  36 Installation
  37 ============
  38
  39 To use sympycore, the following is required:
  40
  41   * Python 2.5 or newer
  42   * optionally, a C/C++ compiler for compiling sympycore
  43   * nose for running sympycore tests
  44
  45 To install compiled sympycore, unpack the archive file, change to the
  46 sympycore source directory ``sympycore-?.?*`` (that contains setup.py
  47 file and sympycore directory), and run (requires C/C++ compiler)::
  48
  49   python setup.py install
  50
  51 To install pure sympycore, copy sympycore source directory to Python
  52 path or just add it to PYTHONPATH or sys.path.
  53
  54 To build and use compiled sympycore without installing it, run::
  55
  56   python setup.py build_ext --inplace
  57
  58 Testing
  59 =======
  60
  61 To test pure Python sympycore from source directory, run::
  62
  63   python setup.py test
  64
  65 To test compiled sympycore from source directory, run::
  66
  67   python setup.py build_ext --inplace test
  68
  69 To test installed sympycore, run::
  70
  71   python -c 'from sympycore import test; test()'
  72
  73 To test sympycore test coverage, run::
  74
  75   python setup.py test --coverage
  76
  77 Basic usage
  78 ===========
  79
  80 Import sympycore with
  81
  82 >>> from sympycore import *
  83
  84 that will provide classes like Symbol, Number, Calculus to construct
  85 symbolic expressions:
  86
  87 >>> x = Symbol('x')
  88 >>> y = Symbol('y')
  89 >>> x + y
  90 Calculus('x + y')
  91
  92 See the following demo page for more examples:
  93
  94   http://sympycore.googlecode.com/svn/trunk/doc/html/demo0_2.html
  95
  96 Additional documentation, including SympyCore User's Guide and API
  97 documentation, is available online in SympyCore website.
  98
  99 Help and bug reports
 100 ====================
 101
 102 You can report bugs at the sympycore issue tracker:
 103
 104   http://code.google.com/p/sympycore/issues/list
 105
 106 SympyCore website contains links to sympycore mailing lists where one
 107 can ask support requests and discuss general sympycore related topics.
 108 Any comments and questions can be sent also to the authors.
 109