Skip to content

Commit 7a025bd

Browse files
committed
Fill out README.rst and add screenshots.
setup.py: use more recent Mathics
1 parent a43c7e3 commit 7a025bd

File tree

5 files changed

+469
-3
lines changed

5 files changed

+469
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
*~
22
/.python-version
3+
/ChangeLog
34
/pymathics_graph.egg-info
45
__pycache__

README.rst

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,60 @@
1-
Mathics Graph Module
1+
`Mathics <https://mathics.org>`_ Graph Module using `NetworkX <https://networkx.org/>`_ and `Matplotlib <https://matplotlib.org>`_
2+
3+
::
4+
5+
Example Session
6+
---------------
7+
8+
::
9+
10+
$ mathicsscript
11+
Mathics 1.1.1
12+
on CPython 3.6.12 (default, Oct 24 2020, 10:34:18)
13+
using SymPy 1.8.dev, mpmath 1.1.0, cython 0.29.21
14+
15+
Copyright (C) 2011-2020 The Mathics Team.
16+
This program comes with ABSOLUTELY NO WARRANTY.
17+
This is free software, and you are welcome to redistribute it
18+
under certain conditions.
19+
See the documentation for the full license.
20+
21+
Quit by pressing CONTROL-D
22+
23+
In[1]:= LoadModule["pymathics.graph"]
24+
Out[1]= pymathics.graph
25+
In[2]:= BinomialTree[3]
26+
In[3]:= BinomialTree[6]
27+
In[4]:= CompleteKaryTree[3, VertexLabels->True]
28+
In[5]:= CompleteKaryTree[6]
29+
30+
Screenshots
31+
-----------
32+
33+
|screenshot|
34+
35+
The above is the is the matplotlib graph for ``BinomialTree[3]`` in the session above.
36+
37+
See the `screenshot directory <https://github.com/Mathics3/pymathics-graph/tree/master/screenshots>`_ the other graphs.
38+
39+
Installation
40+
-------------
41+
42+
From pip:
43+
44+
::
45+
46+
$ pip install pymathics-graph
47+
48+
From git:
249

350
::
451

552
$ make develop # or make install
653

54+
Note:
55+
-----
56+
57+
Currently this works well in `mathicsscript` but not in the Django interface, although graphs are created in a temporary directory, e.g. ``/tmp/``.
58+
759

60+
.. |screenshot| image:: https://github.com/Mathics3/pymathics-graph/blob/master/screenshots/BinomialTree-3.png

0 commit comments

Comments
 (0)