Thun/docs
Simon Forman 1cbeb5d866 Mention the situation with the type code.
I removed it but it's still there in tag v0.4.0 if you want to look at
it.  The Prolog code is just sooooooooo  much more elegant.  it's a rare
case, and a hard decision, but the right thing to do is throw away
working code.  Wow.
2020-05-19 14:09:00 -07:00
..
Advent_of_Code_2017_December_3rd_files Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
dep-graphs Move VUI package/module graph. 2019-05-07 10:00:52 -07:00
jupyter_kernel Initial move of code from git repo. 2018-04-14 18:13:13 -07:00
sphinx_docs Mention the situation with the type code. 2020-05-19 14:09:00 -07:00
with_sympy_files A bunch of docs. 2018-08-24 16:48:15 -07:00
0._This_Implementation_of_Joy_in_Python.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
0._This_Implementation_of_Joy_in_Python.ipynb Fixes #38237 Sort out stack/unstack/enstacken/disenstacken 2020-04-28 10:42:09 -07:00
0._This_Implementation_of_Joy_in_Python.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
0._This_Implementation_of_Joy_in_Python.rst Rebuild docs 2020-05-17 16:40:58 -07:00
1._Basic_Use_of_Joy_in_a_Notebook.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
1._Basic_Use_of_Joy_in_a_Notebook.ipynb Rebuilt some docs. Minor edits. 2020-04-24 16:10:28 -07:00
1._Basic_Use_of_Joy_in_a_Notebook.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
1._Basic_Use_of_Joy_in_a_Notebook.rst Rebuild docs 2020-05-17 16:40:58 -07:00
2._Library_Examples.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
2._Library_Examples.ipynb Fixes #38237 Sort out stack/unstack/enstacken/disenstacken 2020-04-28 10:42:09 -07:00
2._Library_Examples.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
2._Library_Examples.rst Rebuild docs 2020-05-17 16:40:58 -07:00
3._Developing_a_Program.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
3._Developing_a_Program.ipynb The Hylos notebook is not ready for public yet. 2018-06-08 13:05:59 -07:00
3._Developing_a_Program.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
3._Developing_a_Program.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Advent_of_Code_2017_December_1st.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_1st.ipynb Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Advent_of_Code_2017_December_1st.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_1st.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Advent_of_Code_2017_December_2nd.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_2nd.ipynb Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Advent_of_Code_2017_December_2nd.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_2nd.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Advent_of_Code_2017_December_3rd.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_3rd.ipynb Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Advent_of_Code_2017_December_3rd.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_3rd.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Advent_of_Code_2017_December_4th.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_4th.ipynb Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Advent_of_Code_2017_December_4th.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_4th.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Advent_of_Code_2017_December_5th.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_5th.ipynb Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Advent_of_Code_2017_December_5th.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_5th.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Advent_of_Code_2017_December_6th.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_6th.ipynb Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Advent_of_Code_2017_December_6th.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Advent_of_Code_2017_December_6th.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Compiling_Joy.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Compiling_Joy.ipynb A bunch of docs. 2018-08-24 16:48:15 -07:00
Compiling_Joy.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Compiling_Joy.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Correcet_Programming.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Correcet_Programming.ipynb I just want to publish this right quick. 2018-08-24 17:05:42 -07:00
Correcet_Programming.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Correcet_Programming.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Derivatives_of_Regular_Expressions.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Derivatives_of_Regular_Expressions.ipynb Minor docs update. 2020-04-25 14:14:35 -07:00
Derivatives_of_Regular_Expressions.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Derivatives_of_Regular_Expressions.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Document.md Some docs that got swept up in the commotion. 2018-06-06 13:08:04 -07:00
Generator_Programs.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Generator_Programs.ipynb A bit more docs. 2018-07-14 12:07:49 -07:00
Generator_Programs.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Generator_Programs.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Hylo-,_Ana-,_Cata-,_and_Para-morphisms_-_Recursion_Combinators.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Hylo-,_Ana-,_Cata-,_and_Para-morphisms_-_Recursion_Combinators.ipynb The Hylos notebook is not ready for public yet. 2018-06-08 13:05:59 -07:00
Hylo-,_Ana-,_Cata-,_and_Para-morphisms_-_Recursion_Combinators.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Hylo-,_Ana-,_Cata-,_and_Para-morphisms_-_Recursion_Combinators.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Library_Examples.pdf Make cannot deal with spaces in filenames. 2018-06-06 12:57:12 -07:00
Makefile A little more bit o' docs. 2018-07-14 12:29:25 -07:00
Newton-Raphson.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Newton-Raphson.ipynb The Hylos notebook is not ready for public yet. 2018-06-08 13:05:59 -07:00
Newton-Raphson.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Newton-Raphson.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Ordered_Binary_Trees.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Ordered_Binary_Trees.ipynb The version of Python with Anaconda is lightly newer. 2018-08-24 16:46:18 -07:00
Ordered_Binary_Trees.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Ordered_Binary_Trees.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Quadratic.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Quadratic.ipynb The version of Python with Anaconda is lightly newer. 2018-08-24 16:46:18 -07:00
Quadratic.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Quadratic.rst Rebuild docs 2020-05-17 16:40:58 -07:00
README.md Ignore build and virtual env ("venv"). 2020-04-23 18:59:12 -07:00
Recursion_Combinators.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Recursion_Combinators.ipynb The version of Python with Anaconda is lightly newer. 2018-08-24 16:46:18 -07:00
Recursion_Combinators.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Recursion_Combinators.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Replacing.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Replacing.ipynb Rebuild html. 2018-06-08 13:17:36 -07:00
Replacing.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Replacing.rst Rebuild docs 2020-05-17 16:40:58 -07:00
The_Four_Operations.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
The_Four_Operations.ipynb A little more documentation. 2018-07-11 07:13:05 -07:00
The_Four_Operations.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
The_Four_Operations.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Trees.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Trees.ipynb Fixes #38237 Sort out stack/unstack/enstacken/disenstacken 2020-04-28 10:42:09 -07:00
Trees.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Trees.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Treestep.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Treestep.ipynb Bumped version to 0.2.0; docs edits. 2018-06-06 08:47:26 -07:00
Treestep.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Treestep.rst Rebuild docs 2020-05-17 16:40:58 -07:00
TypeChecking.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
TypeChecking.ipynb Finally remove all mentions of the old polytypes module. 2020-04-25 15:59:31 -07:00
TypeChecking.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
TypeChecking.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Types.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Types.ipynb Finally remove all mentions of the old polytypes module. 2020-04-25 15:59:31 -07:00
Types.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Types.rst Rebuild docs 2020-05-17 16:40:58 -07:00
Zipper.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Zipper.ipynb Toplevel makefile docs target uses docs makefile. 2018-06-06 13:33:04 -07:00
Zipper.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
Zipper.rst Rebuild docs 2020-05-17 16:40:58 -07:00
fun_with_scan.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
fun_with_scan.ipynb Better instuctions for running docs notebooks. 2020-04-23 18:53:32 -07:00
fun_with_scan.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
fun_with_scan.rst Rebuild docs 2020-05-17 16:40:58 -07:00
notebook_preamble.py Indent with tabs. 2020-04-28 15:28:58 -07:00
pe1.py Initial move of code from git repo. 2018-04-14 18:13:13 -07:00
pe1.txt Initial move of code from git repo. 2018-04-14 18:13:13 -07:00
repl.py Rename primrec to tailrec. 2020-04-28 11:05:19 -07:00
with_sympy.html Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
with_sympy.ipynb A bunch of docs. 2018-08-24 16:48:15 -07:00
with_sympy.md Rebuild docs with Python 3 and Sphinx 3.0.2. 2020-04-28 15:37:49 -07:00
with_sympy.rst Rebuild docs 2020-05-17 16:40:58 -07:00

README.md

Some Jupyter Notebooks and other material.

All of the notebooks are also available as HTML and Markdown files (generated using nbconvert) so you can view them without running Jupyter.

In order to run the Jupyter Notebooks you need Jupyter (obviously) and you should install Joypy. Here's an example using virtualenv from the project directory:

virtualenv --system-site-packages venv
source ./venv/bin/activate
pip install notebook
python ./setup.py install

Once that's done you should be able to start Jupyter Notebook server with, e.g.:

python -m notebook --ip=0.0.0.0

This starts it using the virtualenv version of Python so joy will be available. Navigate to the joypy/docs directory and the notebooks should be able to import the notebook_preamble.py file.

I find I have to include --ip=0.0.0.0 to workaround a bug where it tries to bind to an IPv6 address, YMMV.

Clean up when you're done:

deactivate 
rm -rf venv

Table of Contents

    1. Basic Use of Joy in a Notebook
    1. Library Examples - Short examples of each word in the dictionary. Various formats.
    1. Developing a Program - Working with the first problem from Project Euler, "Find the sum of all the multiples of 3 or 5 below 1000", several forms of the program are derived.
    1. Replacing Functions in the Dictionary - Shows the basics of defining new "primitive" functions in Python or as definitions and adding them to the dictionary.
  • Factorial Function and Paramorphisms - A basic pattern of recursive control-flow.
  • Generator Programs - Using the x combinator to make generator programs which can be used to create unbounded streams of values.
  • Hylo-, Ana-, Cata-morphisms - Some basic patterns of recursive control-flow structures.
  • Quadratic - Not-so-annoying Quadratic Formula.
  • Trees - Ordered Binary Trees in Joy and more recursion.
  • Zipper - A preliminary examination of the idea of data-structure "zippers" for traversing datastructures.
  • notebook_preamble.py - Imported into notebooks to simplify the preamble code.
  • pe1.py pe1.txt - Set up and execute a Joy program for the first problem from Project Euler. The pe1.txt file is the trace. It's 2.8M uncompressed. Compressed with gzip it becomes just 0.12M.
  • repl.py - Run this script to start a REPL. Useful for e.g. running Joy code in a debugger.

Notes

One of the things that interests me about Joy is how programming becomes less about writing code and more about sound reasoning about simple (almost geometric) programs. Many of the notebooks in this collection consist of several pages of discussion to arrive at a few lines of Joy definitions. I think this is a good thing. This is "literate programming". The "programs" resemble mathematical proofs. You aren't implementing so much as deriving. The structure of Joy seems to force you to think clearly about the task in a way that is reliable but extremely flexible. It feels like a puzzle game, and the puzzles are often simple, and the solutions build on each other.