Merge pull request #21 from fangohr/improvements-for-binder

Improvements for binder: minimal requirements to avoid using Dockerfile for binder, and to speed up build time for Binder.

[Could be improved in that we now don't test the notebooks in the Binder environment.]

Author: fangohr

Makefile

@@ -41,15 +41,19 @@ docker-build-nocache:
 
 # Here we only bind the required directories and files into the docker container
 # at runtime to avoid potential conflicts with local files
+
 define DOCKER_RUN
-docker run -u $(id -u ${USER}):$(id -g ${USER}) \
+docker run --workdir=/io  \
 	-v $(CURDIR)/book:/io/book \
 	-v $(CURDIR)/Makefile:/io/Makefile \
 	-v $(CURDIR)/poetry.lock:/io/poetry.lock \
 	-v $(CURDIR)/pyproject.toml:/io/pyproject.toml \
 	python4compscience
 endef
 
+docker-bash:
+	docker run --workdir=/io -t -i -v $(CURDIR):/io python4compscience bash
+
 docker-html:
 	$(DOCKER_RUN) make html
 

binder/info.org

@@ -0,0 +1,30 @@
+* Overall strategy: separate Docker containers for development and mybinder
+
+This repository uses a Dockerfile in the root directory for development
+purposes. This includes translation of the source files (in book/*ipynb) to html
+and pdf (using jupyterbook), which in turns needs a full latex installation.
+
+That makes the container quite big.
+
+For myBinder, we do not need latex, so in this directory, we attempt to have a
+leaner definition of dependencies.
+
+Binder should look in this directory (as it is called 'binder') and ignore the
+global Dockerfile.
+
+* Re-use dependencies from development environment in myBinder
+
+I don't know if myBinder could read dependencies from a pyproject.toml file (and
+couldn't find any documentation on this yet), nor if we can extract a
+requirements.txt file from the pyproject.toml file automatically.
+
+As a first step towards making the binder image leaner, I will stick to a definition via a Dockerfile, and leave out latex to make it smaller.
+
+This didn't go so well.
+
+Next attempt: specifying the packages we need in requirements.txt directly. It's
+not ideal, as we don't run tests on the particular versions, and we duplicate
+some effort from ../pyproject.toml here in reqiuirements.txt. On the positive
+side, Binder start-up time could be much smaller (and Binder work at all).
+
+

binder/requirements.txt

@@ -0,0 +1,7 @@
+numpy
+scipy
+sympy
+matplotlib
+pandas
+ipython
+pytest

poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+create = false