Skip to content

Commit

Permalink
some grammar/spell fix
Browse files Browse the repository at this point in the history
  • Loading branch information
TsumiNa committed Dec 24, 2018
1 parent dc32a8a commit 24633d7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
2 changes: 0 additions & 2 deletions devtools/readthedocs.yml
Expand Up @@ -14,8 +14,6 @@ dependencies:
- scikit-learn
- scipy
- pytorch-cpu
- sphinx
- sphinx_rtd_theme
- pip:
- ruamel.yaml
- pymatgen
8 changes: 5 additions & 3 deletions docs/source/installation.rst
Expand Up @@ -65,15 +65,16 @@ Use docker

Docker is a tool designed to make it easier to create, deploy, and run applications by using containers.
Containers allow a developer to package up an application with all of the parts it needs, such as libraries and other dependencies, and ship it all out as one package.
We provide the `official docker images`_ via the `Docker hub <https://hub.docker.com>`_.

We provided the `official docker images`_ on `Docker hub <https://hub.docker.com>`_.
After you installed the docker on your machine, use XenonPy with jupyterlab is just a one line command.
Follow the `official documents <https://docs.docker.com/install/>`_ to insstall docker CE on your machine.
If you don't have installed Docker yet, Follow the `official install tutorial <https://docs.docker.com/install/>`_ to install docker CE on your machine.
Once your docker installation is done, use the following command to boot up XenonPy with jupyterlab_.

.. code-block:: bash
$ docker run --rm -it -v $HOME/.xenonpy:/root/.xenonpy -v <path/to/your/work_space>:/root -p 8888:8888 yoshidalab/xenonpy
Then open http://localhost:8888 from your favourite browser.

Install in development mode
===========================
Expand Down Expand Up @@ -119,3 +120,4 @@ Please provide fully detailed information (system specification, Python version,
.. _Gitter: https://gitter.im/yoshida-lab/XenonPy
.. _PyTorch: http://pytorch.org/
.. _rdkit: https://www.rdkit.org/
.. _jupyterlab: https://jupyterlab.readthedocs.io/en/stable/
3 changes: 3 additions & 0 deletions readthedocs.yml
Expand Up @@ -4,5 +4,8 @@ conda:
build:
image: latest

formats:
- pdf

python:
version: 3.6

0 comments on commit 24633d7

Please sign in to comment.