Документирование вашей работы является неотъемлемой частью вашей разработки, но если вы кто -то вроде меня и вы должны поделиться своей работой с различным набором технической и нетехнической аудитории, вы, вероятно, сделаете дополнительную милю, чтобы создать отдельные версии одних и тех же результатов, один с кодом для ваших коллег, и один для заинтересованных сторон, которые могут найти Код страшно или отвлекает, если не сказать больше. Записная книжка Юпитера Делает мою жизнь намного проще для работы, связанной с анализом данных. Хотя Nopyter Notebook поддерживает различные языки программирования, такие как Юлия , Python а также R Для живого кода и визуализаций вместе с Markdown , Html и другие для повествовательного текста, в этом посте мы увидим пример с кодом Python.
Установка необходимых пакетов
Предполагая, что в ваших системах уже установлены Jupyter и Python, вам необходимо установить следующие пакеты дополнительно:
nbconvert
Инструменты NBConvert используют Джинджа Шаблоны для преобразования ваших ноутбуков Jupyter в различные форматы документов, такие как HTML, латекс, pdf, js, markdown, реструктурированный текст (RST) и исполняемый сценарий. Вы можете установить NBConvert, используя любую из команд в зависимости от вашего диспетчера пакетов Python:
PIP установить NBConvert Conda install -c anaconda nbconvert
Для преобразования ноутбука в нужный выходной формат используйте следующую структуру команды:
$ jupyter nbconvert -to <формат вывода> <входной ноутбук>
Hide_code
Hide_code – это расширение для вашей ноутбука Jupyter, которая позволяет выборочно скрывать код, подсказка и выходы в ноутбуке Jupyter. Это также позволяет экспортировать эти ноутбуки в HTML, латекс и PDF. После установки hide_code в вашей системе вы можете включить его, нажав View -> Панель инструментов ячейки -> скрыть код в меню ноутбука Jupyter.
Вы можете установить hide_code, используя следующие команды:
PIP установить hide_code jupyter nbextension install -py hide_code jupyter nbextension enable -py hide_code jupyter serverextension enable -py hide_code
Вы можете экспортировать свои ноутбуки в желаемый формат, используя следующие команды: В HTML jupyter nbconvert -to hide_code_html Notebook_to_convert.ipynb В PDF jupyter nbconvert -to hide_code_pdf Notebook_to_convert.ipynb В латекс jupyter nbconvert -to hide_code_latexpdf Notebook_to_convert.ipynb
Таблица
Tabulate – это пакет Python, используемый для симпатичной печатной таблицы в Python. Вы можете установить таблицу, используя любую из следующих команд: PIP установить таблицу Conda Install -c Conda -Forge Tabulate
Создание ноутбука
Я создал Демо -ноутбук На GitHub, который вы можете расколоть, загрузить или работать с вашим собственным примером.
Написание повествовательного текста
Чтобы написать повествовательный текст в Markdown или HTML, нажмите «Cell -> Type -> Markdown» в меню Jupyter или нажмите «ESC + M» на клавиатуре. Это Учебник дает хорошее представление о размещении.
Включить hide_code
Включите hide_code, который дает вам параметры, чтобы «скрыть приглашение», «скрыть код» и «скрыть ячейку» в правом верхнем углу каждой ячейки в записной книжке. Использование следующей команды преобразование ноутбука в формат LaTex. jupyter nbconvert -to hide_code_latex Notebook_to_convert.ipynb
Добавление цветов в ваш латексный файл
По умолчанию экспорт черно -белый. Вы можете добавить цвет к своему элементу латекса, используя следующую команду: {\ color {
Вы можете раскрасить целые разделы, используя следующие глобальные определения: \ usepackage {sectsty} \ gaturefont {\ color {brown}} \ sectionfont {\ color {brown}} \ subsectionfont {\ color {brown}} \ subsubsectionfont {\ color {teal}} \ date {\ color {brown} 10 июня 2019 г.}
Вы можете глубоко погрузиться в Латекс Если вы хотите настроить его полностью. Это подводит нас к концу этого поста. Надеюсь, вы найдете это полезным! Этот пост был первоначально опубликован в Алефтофты Анкет
Оригинал: “https://dev.to/alephthoughts/publication-ready-jupyter-notebooks-47ca”