Install the environment#
In order to create and work on your Jupyter Book, you need to download some programs.
Install Conda#
You can download and install Conda via Miniconda
. If you do not already have a Python version on your computer, it is better to search the section at the page that includes the latest Python version.
A note for Windows users
Jupyter Book is now also tested against Windows OS! However, there is a known incompatibility for notebook execution when using Python 3.8.
If you use Windows OS, please, download the Python 3.7 version.
Miniconda VS Anaconda
If you want a better experience while installing more packages, you can download Anaconda
which offers a graphical environment for the handling of the packages.
‘Conda’ is not recognized
It is suggested to select to add conda to the PATH while installing either Miniconda or Anaconda.
However, if you still get the error message follow the instructions at: ‘Conda’ is not recognized as internal or external command.
Terminal Emulator
During the install process and the creating, building and publishing of your book you will need to use a terminal emulator. It is suggested to use Microsoft's Command Prompt
(for Windows only) or Anaconda Prompt
, especially if you are using Dataspell
as an editor.
Find more at: Terminal emulator
Install Git#
You can install Git via Git. It is necessary in order to execute commands and connect to the GitLab repository. Using Git will allow you not only to colaborate & track your versions during the development process, it will also play an important role in publishing & hosting your book online.
‘Git’ is not recognized
If you get the error message while trying to execute a command, follow the instructions at: Error “‘git’ is not recognized as an internal or external command”.
Install Jupyter Book#
In your terminal, you can install Jupyter Book via pip
:
pip install -U jupyter-book
This will install everything you need to build a Jupyter Book locally.
Install Globally or inside Environment?
It is suggested to download Jupyter Book package in the base configuration of Conda. However, if you want to download it only for a specific environment, first create and activate one.
Find more about environments at: Create environment
Install DataSpell (Optional)#
You can install DataSpell via DataSpell
. JetBrains DataSpell is an Integrated Development Environment (IDE) for data science with intelligent Jupyter notebooks, interactive Python scripts, and lots of other built-in tools. You can use also other IDEs, such as VSCode.
It is very useful to have an editor with all the built-in tools for Jupyter Book development.
More Information#
Find more information about creating your book: