diff --git a/docs/linux-install.rst b/docs/linux-install.rst index 480a0dcb6..bcccae899 100644 --- a/docs/linux-install.rst +++ b/docs/linux-install.rst @@ -52,6 +52,9 @@ should get you up and running: python -m pip install -e . python -m pip install -r jupyter/requirements.txt + cd jupyter + python -m pip install nbstripout + nbstripout --install After running these install instructions, make sure to restart your computer. This is required for the new udev rules to be applied. @@ -184,6 +187,14 @@ With that done, all that's left is to install ChipWhisperer: python -m pip install -e . python -m pip install -r jupyter/requirements.txt +You may also want to grab `nbstripout`_, which will make git and jupyter interact a little nicer: + +.. code:: bash + + cd jupyter + pip install nbstripout + nbstripout --install # must be run from the jupyter folder + You can check that the install succeeded by navigating to :code:`chipwhisperer` and running: @@ -193,4 +204,5 @@ and running: Which should open a window like the following in your browser: -.. image:: _images/Jupyter\ ChipWhisperer.png \ No newline at end of file +.. image:: _images/Jupyter\ ChipWhisperer.png +.. _nbstripout: https://github.com/kynan/nbstripout \ No newline at end of file diff --git a/docs/windows-install.rst b/docs/windows-install.rst index a2f60f685..4903b5420 100644 --- a/docs/windows-install.rst +++ b/docs/windows-install.rst @@ -142,6 +142,14 @@ You can clone and install ChipWhisperer by running the following commands in Git python -m pip install -e . python -m pip install -r jupyter/requirements.txt +You may also want to grab `nbstripout`_, which will make git and jupyter interact a little nicer: + +.. code:: bash + + cd jupyter + pip install nbstripout + nbstripout --install # must be run from the jupyter folder + If everything there completes successfully, then congratulations, you've successfully installed ChipWhisperer! All that's left is to launch Jupyter and run the verification notebooks. Run the following in Git Bash: @@ -162,4 +170,5 @@ to verify that everything installed correctly. If you run into any issues, pleas .. _arm-none-eabi-gcc: https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads .. _avr-gcc: https://blog.zakkemble.net/avr-gcc-builds/ .. _git-bash: https://git-scm.com/downloads -.. _WinPython: https://sourceforge.net/projects/winpython/files/ \ No newline at end of file +.. _WinPython: https://sourceforge.net/projects/winpython/files/ +.. _nbstripout: https://github.com/kynan/nbstripout \ No newline at end of file