Tree [dbd4af] master /
 History

HTTPS access


File Date Author Commit
 bin 2016-04-20 Colin B. Macdonald Colin B. Macdonald [f1d81d] allow other python executables on Windows
 inst 2017-08-06 Colin B. Macdonald Colin B. Macdonald [4911f1] diagnose: better use of whitespace and clarify ...
 misc 2016-11-03 Colin B. Macdonald Colin B. Macdonald [6c4ca1] [maint] move matlab comment converter to util dir
 util 2016-11-04 Colin B. Macdonald Colin B. Macdonald [63c890] [maint] move packaging script
 .gitignore 2016-05-08 Colin B. Macdonald Colin B. Macdonald [e5d3ae] [maint] gitignore octave-workspace
 .mailmap 2016-10-04 Colin B. Macdonald Colin B. Macdonald [ef5bc8] [maint] Add git mailmap file
 .travis.yml 2017-08-04 Mike Miller Mike Miller [d4fe79] ci: refactor Python version selection
 CONTRIBUTORS 2017-01-15 Colin B. Macdonald Colin B. Macdonald [d03c08] [maint] update contributors
 COPYING 2014-04-16 Colin B. Macdonald Colin B. Macdonald [801fd8] rename license file
 DESCRIPTION 2016-05-25 Colin B. Macdonald Colin B. Macdonald [b9067d] [maint] version bumps for release
 HOWTO-release.md 2016-11-12 Colin B. Macdonald Colin B. Macdonald [2e186d] remove references to "snippets"
 INDEX unknown
 Makefile 2016-11-14 Mike Miller Mike Miller [c810cc] Makefile: delete log file in correct location
 NEWS 2017-08-06 Colin B. Macdonald Colin B. Macdonald [dbd4af] update NEWS
 README.bundled.md 2014-08-27 Colin B. Macdonald Colin B. Macdonald [5379be] a README file for the windows package with bund...
 README.matlab.md 2014-07-14 Colin B. Macdonald Colin B. Macdonald [28d0f1] update matlab comments and texinfo fix noted wh...
 README.md 2016-11-01 Mike Miller Mike Miller [e04ba6] README: Add Travis build status badge
 TODO.md 2015-02-05 Colin B. Macdonald Colin B. Macdonald [55b58d] cleanup comments, minor edits
 matlab_smt_differences.md 2015-06-25 Colin B. Macdonald Colin B. Macdonald [26aa46] Document that Matlab's SMT choses transform var...
 octave-symbolic.metainfo.xml 2016-02-05 Colin B. Macdonald Colin B. Macdonald [06e4ff] [maint] add empty translation tag, we have no g...
 screenshot-install.png 2015-01-23 Colin B. Macdonald Colin B. Macdonald [5126ac] update screenshot, e.g., for website
 screenshot.png 2014-08-27 Colin B. Macdonald Colin B. Macdonald [3916d1] update screenshots

Read Me

OctSymPy

Build Status

An implementation of a symbolic toolbox using SymPy.

[https://github.com/cbm755/octsympy]

Goals

Feature parity with the other symbolic toolboxes.

Screenshot 1

Screenshot 2

How to Install

  1. The dependencies are Octave, Python, and SymPy. Consult the SymPy
    website for details on how to install SymPy.

  2. Start Octave.

  3. At Octave prompt type pkg install -forge symbolic.

  4. At Octave prompt, type pkg load symbolic.

  5. At Octave prompt, type syms x, then f = (sin(x/2))^3,
    diff(f, x), etc.

How to install on Ubuntu

  1. Install the dependencies with
    sudo apt-get install octave liboctave-dev python-sympy.
  2. Follow steps 2--5 above.

How to Install on Windows

  1. Get Octave for Windows.

  2. Download the symbolic-win-py-bundle-2.5.0.zip file from
    releases.

  3. Start Octave

  4. At the Octave prompt, type pkg install symbolic-win-py-bundle-2.5.0.zip.

  5. At the Octave prompt, type pkg load symbolic.

  6. At the Octave prompt, type syms x, then f = (sin(x/2))^3,
    diff(f, x), etc.

The symbolic-win-py-bundle package should have no dependencies other than
Octave (it includes SymPy and a Python interpreter). Alternatively, you can
install Python and SymPy yourself and use the standard
pkg install -forge symbolic command.

If you encounter any difficulties (even minor ones) please read and
if possible help us improve the
wiki page on Windows Installation.

How to Install on Matlab

Although this package is designed for GNU Octave, it will work with
Matlab. Currently only the slower system()-based communication is
available.

  1. Download the latest release, e.g., octsympy-matlab-2.5.0.tar.gz.

  2. Unzip is somewhere and add it to your Matlab Path.

The .m files for Matlab have been reformatted for Matlab comment
conventions, but are otherwise the same as the Octave source.

How to Help

We have a list of things to work on tagged help
wanted
.
Some of these should be quite easy to fix and would be a great way to
get involved. Come join us!

How to hack on the code:

  1. Clone the repo with git (preferred, but you can use the "Download
    ZIP" instead if you want).

  2. Run Octave in the octsympy/inst/ directory. It should be safe
    to do this even if you have the released version of the package
    installed (but not loaded).

Implementation

Python code is generated to do the actual work. Each sym object keeps
a text field for display purposes and a string (a SymPy srepr). The
objects are communicated between Python and Octave by passing the
srepr string back-and-forth. Currently pure m-file (and Python)
implementation, no code to be compiled.

  • There was a previous "symbolic" package in Octave Forge based on
    GiNaC. Its history has now been merged into this project.

  • "SymPy CAS" by Jonathan Lister.
    Calls SymPy commands using system().