Skip to content

Commit

Permalink
V0.9.2 and doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
gutow committed Jun 5, 2022
1 parent 33a90c9 commit fd08dbc
Show file tree
Hide file tree
Showing 6 changed files with 9,441 additions and 8,475 deletions.
2 changes: 1 addition & 1 deletion ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ github](https://github.com/gutow/Algebra_with_Sympy/issues).

#### Change Log

* 0.9.2rc0
* 0.9.2
* `=@` shorthand syntax for defining equations in IPython compatible
environments.
* Fixed bug where `root()` override called `sqrt()` on bare expressions.
Expand Down
72 changes: 47 additions & 25 deletions docs/algebra_with_sympy.html

Large diffs are not rendered by default.

17,817 changes: 9,372 additions & 8,445 deletions docs/algebra_with_sympy/algebraic_equation.html

Large diffs are not rendered by default.

21 changes: 19 additions & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,26 @@ over missed details such as a negative sign.

A simple example as it would appear in a [Jupyter](https://jupyter.org)
notebook is shown immediately below:
![screenshot of simple example](./resources/simple_example.png)
![screenshot of simple example](https://gutow.github.io/Algebra_with_Sympy/resources/simple_example.png)

Once the algebra is complete it is possible to substitute numbers with
units into the solved equation to calculate a numerical solution with
proper units.

[More examples here](Demonstration%20of%20equation%20class.html).
In IPython environments (IPython and Jupyter) there is also a shorthand
syntax for entering equations provided through the IPython preparser. An
equation can be specified as `eq1 =@ a/b = c/d`. If no Python name is
specified for the equation (`eq1` left out in the previous example), the
equation will still
be defined, but will not be easily accessible for further computation. The
`=@` symbol combination was chosen to avoid conflicts with reserved python
symbols while minimizing impacts on syntax highlighting and autoformatting. A
screenshot of an example in Jupyter is shown immediately below:

![screenshot of short syntax](https://gutow.github.io/Algebra_with_Sympy/resources/short_syntax.png)

[More examples of the capabilities of Algebra with Sympy are
here](https://gutow.github.io/Algebra_with_Sympy/Demonstration%20of%20equation%20class.html).

Many math packages such as [SageMath](https://www.sagemath.org/)
and [Maxima](http://maxima.sourceforge.net/) have similar capabilities,
Expand Down Expand Up @@ -91,6 +104,10 @@ github](https://github.com/gutow/Algebra_with_Sympy/issues).

#### Change Log

* 0.9.2
* `=@` shorthand syntax for defining equations in IPython compatible
environments.
* Fixed bug where `root()` override called `sqrt()` on bare expressions.
* 0.9.1
* Equations labeled with their python name, if they have one.
* Added flags to adjust human readable output and equation labeling.
Expand Down
2 changes: 1 addition & 1 deletion docs/search.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
setuptools.setup(
name="Algebra_with_SymPy",
url = "https://gutow.github.io/Algebra_with_Sympy/",
version="0.9.1.1",
version="0.9.2",
description="Equations that can be algebraicly manipulated.",
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit fd08dbc

Please sign in to comment.