|
1 |
| -Binder computing environment using SageMath |
2 |
| -=========================================== |
| 1 | +A Binder repo for SageMath computing environment |
| 2 | +================================================ |
| 3 | + |
| 4 | +This repository is a Binder repo based on `SageMath <http://sagemath.org>`_. To |
| 5 | +access a computing environment created by `Binder <http://mybinder.org>`_ using |
| 6 | +SageMath kernel, click on this badge |
3 | 7 |
|
4 | 8 | .. image:: https://mybinder.org/badge_logo.svg
|
5 | 9 | :target: https://mybinder.org/v2/gh/kwankyu/sage-binder-env/master
|
6 | 10 |
|
7 |
| -This repository provides a `Binder <http://mybinder.org>`_ repo based on |
8 |
| -`SageMath <http://sagemath.org>`_. |
9 | 11 |
|
| 12 | +An example Binder repo for SageMath |
| 13 | +----------------------------------- |
| 14 | + |
| 15 | +Have a repository full of Jupyter notebooks using SageMath? It's easy to setup |
| 16 | +Binder to let anyone run them. Just fork this repo, put your notebooks in the |
| 17 | +`notebooks` directory. and modify this `README.rst` to your needs. In |
| 18 | +particular, you probably want to modify this line:: |
10 | 19 |
|
11 |
| -An example of binder repository for SageMath |
12 |
| --------------------------------------------- |
| 20 | +:target: https://mybinder.org/v2/gh/... |
13 | 21 |
|
14 |
| -Have a repository full of Jupyter notebooks using SageMath? It's easy |
15 |
| -to setup Binder to let anyone run them. Just copy the short |
16 |
| -`Dockerfile <Dockerfile>`_ from this repository, and adapt it to your needs. You |
17 |
| -probably also want to insert the Binder badge in your `README.rst`. |
| 22 | +with `...` replaced with your forked repo. This makes the Binder badge use your |
| 23 | +repo to create the Jupyter server. |
18 | 24 |
|
19 | 25 |
|
20 | 26 | Extending the sagemath Docker image
|
21 | 27 | -----------------------------------
|
22 | 28 |
|
23 |
| -The sample `Dockerfile` in this repository is based on the official sagemath |
24 |
| -Docker image. It includes Sage itself, and all the software packages typically |
25 |
| -included in a standard Sage installation, though not *everything* (in |
26 |
| -particular not optional Sage SPKGs, or other system software packages). |
| 29 | +The `Dockerfile` builds Sage with base Docker image:: |
| 30 | + |
| 31 | + FROM ghcr.io/sagemath/sage/sage-ubuntu-focal-standard-with-targets-optional:dev |
| 32 | + |
| 33 | +which contains Sage built in the current *develop* branch. |
27 | 34 |
|
28 |
| -So in order to install additional Sage SPKGs it is possible to include a line like:: |
| 35 | +It includes Sage itself, and all the software packages typically |
| 36 | +included in a standard Sage installation, though not *everything*. In |
| 37 | +particular not optional Sage SPKGs, or other system software packages. |
| 38 | + |
| 39 | +So in order to install additional Sage SPKGs, it is possible to include a line like:: |
29 | 40 |
|
30 | 41 | RUN sage -i <spkg-name>
|
31 | 42 |
|
32 |
| -in the ``Dockerfile``. |
| 43 | +in the `Dockerfile`. |
| 44 | + |
| 45 | + |
| 46 | +Authors |
| 47 | +------- |
| 48 | + |
| 49 | +Nicolas M. Thiéry, E. Madison Bray, and Kwankyu Lee |
0 commit comments