Engee на старт!

🧶Сшить проект с помощью ноутбука Engee

Бывают проекты из одного файла или где нужен разветвленный репозиторий, но чаще всего я работаю над кодом в одиночку. Долгое время его никому не нужно передавать, и проект разрастается до 5 тысяч строк. Поскольку неудобно вести стихийную разработку в десятках разрозненных файлов, я предпочитаю всё держать в одном ноутбуке. И это вовсе не проблема.

В Engee мне нравится то, что среда ноутбуков сделана для инженеров-исследователей. Например, есть удобное файловое хранилище с выходом в git и полная интеграция с мощной инженерной средой для симуляции схем.

Если большой проект находится в одном файле, разве его не будет трудно читать? Оказывается, это не трудно и даже удобно, если проект делить на иерархические сегменты и сворачивать ненужные секции. Насколько это полезно, я понял на своём опыте, когда собирал семинар по оптимизации из большого набора примеров. Получился очень удобный учебник, а работать с секциями в ноутбуке было гораздо удобнее, чем с отдельными файлами.

👨‍🏫 Интерактивный семинар в Engee

Какой формат лучший для инженерного семинара? Этот вопрос волновал меня в аспирантуре. Как совместить процессы разработки и презентации, чтобы использовать один и тот же график и в методичке, и в публикации? Приходилось выстраивать цепочки инструментов и придумывать свои форматы, неэффективно сжигая недели продуктивной работы.

В Engee к мощному редактору схем прилагается редактор ноутбуков, куда можно поместить код, результаты выполнения, интерактивные графики, видео с лекциями и примерами, заметки и теоретические выкладки… и почти все, на что хватит воображения.

Нужно добавить интерактивный обновляемый граф? Вот несколько способов:

🔹загрузить его из файла с удаленного сервера, git или облака;
🔹загрузить исходные данные и создать объект в скрипте;
🔹обойтись без внешних файлов – спрятать данные в одну из ячеек ноутбука.

Напишите в комментариях, какие инструменты вам пригодятся на лекции, и в ответ мы покажем, как их реализовать в Engee👇

📝 Естественный способ делать расчеты, не требующие дополнительных пояснений.

Делать самодокументируемые расчеты в форме ноутбуков - это очень легко и полезно даже самому автору. Однажды мне пришлось долго разбираться с 20-ю файлами кода автопилота. Вместо документации у меня были скудные комментарии в коде и ссылка на внутреннюю вики за VPN, которого у меня не было. Автор еще работал в команде, но уже и сам забыл причины выбора одного из устаревших алгоритмов.

В итоге алгоритм автопилота я разобрал и улучшил за три недели, но без ноутбуков это привело к чрезмерной растрате времени.

Почему бы всем и всегда не писать вменяемые заметки, формулы, картинки и не размещать фрагменты документации рядом как ДО так и после секции с кодом? В инженерных задачах это должна быть одна из best-practice.

Кстати, ноутбуки в Engee на мой взгляд круче, чем в Google Colab. Если интересно напишите в комменты - выложу пример👇

👨‍💻 Редактор ноутбуков в Engee

💻 В Engee для написания кода используется формат ноутбуков. Код в ноутбуках разделяется на блоки (или кодовые ячейки). Рядом, в текстовых ячейках, размещается любой сопроводительный текст в форматах markdown и HTML, где допустимы почти любые мультимедиа-материалы – ссылки, изображения, формулы в LaTeX и видеовставки через iframe.

🔎 В одном из режимов отображения, код ноутбуков временно скрывается от читателя, хотя его всё ещё можно выполнять. От ноутбука остаются только текстовые ячейки и кодовый вывод, который тоже можно очистить. Полученный документ может представлять собой иллюстрированное руководство или стандартную документацию, или ещё – методичку для учебного курса.

⚙️ В одном ноутбуке можно собрать много модулей. А благодаря иерархической системе заголовков, секции кода, которые не нужны в данный момент перед глазами, можно "свернуть". Тогда вы будете видеть только те секции, надо которыми сейчас работаете.

Channel name was changed to «Engee - start»

Channel created