kopia lustrzana https://github.com/jupyterhub/repo2docker
Add basic documentation on Zenodo content provider
rodzic
363c962efd
commit
c96cadafad
|
@ -2,11 +2,14 @@ jupyter-repo2docker
|
||||||
===================
|
===================
|
||||||
|
|
||||||
``jupyter-repo2docker`` is a tool to **build, run, and push Docker
|
``jupyter-repo2docker`` is a tool to **build, run, and push Docker
|
||||||
images from source code repositories** that run via a Jupyter server.
|
images from source code repositories**.
|
||||||
|
|
||||||
``repo2docker`` fetches a repository
|
``repo2docker`` fetches a repository
|
||||||
(from GitHub, GitLab or other locations) and builds a container image
|
(from GitHub, GitLab, Zenodo, a Git repository or a local directory)
|
||||||
based on the configuration files found in the repository. It can be
|
and builds a container image inn which the code can be executed.
|
||||||
|
The image build process is based on the configuration files found in the repository.
|
||||||
|
|
||||||
|
``repo2docker`` can be
|
||||||
used to explore a repository locally by building and executing the
|
used to explore a repository locally by building and executing the
|
||||||
constructed image of the repository, or as a means of building images that
|
constructed image of the repository, or as a means of building images that
|
||||||
are pushed to a Docker registry.
|
are pushed to a Docker registry.
|
||||||
|
|
|
@ -11,14 +11,15 @@ Using ``repo2docker``
|
||||||
``repo2docker``, see :ref:`install`.
|
``repo2docker``, see :ref:`install`.
|
||||||
|
|
||||||
``repo2docker`` can build a reproducible computational environment for any repository that
|
``repo2docker`` can build a reproducible computational environment for any repository that
|
||||||
follows :ref:`specification`. repo2docker is called with a URL/path to a repository. It then
|
follows :ref:`specification`. repo2docker is called with the URL of a Git repository,
|
||||||
|
a Zenodo DOI or a path to a local directory. It then
|
||||||
performs these steps:
|
performs these steps:
|
||||||
|
|
||||||
1. Inspects the repository for :ref:`configuration files <config-files>`. These will be used to build
|
1. Inspects the repository for :ref:`configuration files <config-files>`. These will be used to build
|
||||||
the environment needed to run the repository.
|
the environment needed to run the repository.
|
||||||
2. Builds a Docker image with an environment specified in these :ref:`configuration files <config-files>`.
|
2. Builds a Docker image with an environment specified in these :ref:`configuration files <config-files>`.
|
||||||
3. Runs a Jupyter server within the image that lets you explore the
|
3. Launches the image to let you explore the
|
||||||
repository interactively (optional)
|
repository interactively via Jupyter notebooks, RStudio, or many other interfaces (optional)
|
||||||
4. Pushes the images to a Docker registry so that it may be accessed remotely
|
4. Pushes the images to a Docker registry so that it may be accessed remotely
|
||||||
(optional)
|
(optional)
|
||||||
|
|
||||||
|
@ -27,10 +28,15 @@ Calling repo2docker
|
||||||
|
|
||||||
repo2docker is called with this command::
|
repo2docker is called with this command::
|
||||||
|
|
||||||
jupyter-repo2docker <URL-or-path to repository>
|
jupyter-repo2docker <source-repository>
|
||||||
|
|
||||||
where ``<URL-or-path to repository>`` is a URL or path to the source repository
|
where ``<source-repository>`` is:
|
||||||
for which you'd like to build an image.
|
|
||||||
|
* a URL of a Git repository (``https://github.com/binder-examples/requirements``),
|
||||||
|
* a Zenodo DOI (``10.5281/zenodo.1211089``), or
|
||||||
|
* a path to a local directory (``a/local/directory``)
|
||||||
|
|
||||||
|
of the source repository you want to build.
|
||||||
|
|
||||||
For example, the following command will build an image of Peter Norvig's
|
For example, the following command will build an image of Peter Norvig's
|
||||||
Pytudes_ repository::
|
Pytudes_ repository::
|
||||||
|
|
Ładowanie…
Reference in New Issue