sforman
/
Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Wrap README.md

This commit is contained in:
Simon Forman 2021-11-22 19:48:59 -08:00
parent 9ede53f780
commit 3be8efc92f
1 changed files with 35 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/README.md
View File

@ -1,21 +1,28 @@
# Some Jupyter Notebooks and other material. # 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. 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](https://jupyter.org/index.html) you need Jupyter (obviously) and you should install `Joypy`. Here's an example using `virtualenv` from the project directory: In order to run the [Jupyter Notebooks](https://jupyter.org/index.html)
you need Jupyter (obviously) and you should install `Joypy`. Here's an
example using `virtualenv` from the project directory:
virtualenv --system-site-packages venv virtualenv --system-site-packages venv
source ./venv/bin/activate source ./venv/bin/activate
pip install notebook pip install notebook
python ./setup.py install python ./setup.py install
Once that's done you should be able to start Jupyter Notebook server with, e.g.: Once that's done you should be able to start Jupyter Notebook server
with, e.g.:
python -m notebook --ip=0.0.0.0 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. 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. 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: Clean up when you're done:
@ -27,18 +34,31 @@ Clean up when you're done:
## Table of Contents ## Table of Contents
- 1. Basic Use of Joy in a Notebook - 1. Basic Use of Joy in a Notebook
- 2. Library Examples - Short examples of each word in the dictionary. Various formats. - 2. Library Examples - Short examples of each word in the dictionary.
- 3. 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. Various formats.
- 4. Replacing Functions in the Dictionary - Shows the basics of defining new "primitive" functions in Python or as definitions and adding them to the dictionary. - 3. Developing a Program - Working with the first problem from Project
- Factorial Function and Paramorphisms - A basic pattern of recursive control-flow. Euler, "Find the sum of all the multiples of 3 or 5 below 1000",
- Generator Programs - Using the x combinator to make generator programs which can be used to create unbounded streams of values. several forms of the program are derived.
- Hylo-, Ana-, Cata-morphisms - Some basic patterns of recursive control-flow structures. - 4. 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. - Quadratic - Not-so-annoying Quadratic Formula.
- Trees - Ordered Binary Trees in Joy and more recursion. - Trees - Ordered Binary Trees in Joy and more recursion.
- Zipper - A preliminary examination of the idea of data-structure "zippers" for traversing datastructures. - Zipper - A preliminary examination of the idea of data-structure
- notebook_preamble.py - Imported into notebooks to simplify the preamble code. "zippers" for traversing datastructures.
- 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. - notebook_preamble.py - Imported into notebooks to simplify the preamble
- repl.py - Run this script to start a REPL. Useful for e.g. running Joy code in a debugger. 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 ## Notes