malstroem

Quick start

To use malstroem, do the following in an Anaconda console.

git clone https://github.com/septima/malstroem
cd malstroem
conda env create -f environment-dev.yml
conda activate malstroem

Then install in locally editable (-e) mode and run the tests.

pip install -e .[test]
py.test

If you want to run the speedups they need to be compiled at installation time.

    pip install -e .[test,speedups]
    py.test

Written in restructuredText and compiled using sphinx.

After changes to malstroem code recreate apidoc

sphinx-apidoc -f -a -H malstroem -A "Asger Skovbo Petersen, Septima" -V 0.0.1 -o docs/api malstroem

Make html documentation:

cd docs
make html
open _build/html/index.html

Make pdf documentation

cd docs
make tectonicpdf
open _build/latex/malstroem.pdf

or

cd docs
make latex
cd _build/latex/
tectonic *.tex
open malstroem.pdf