Правила подготовки лекций и глав

Основа — docs/book-authoring-guide.md курса stat-course: ответственность автора, научная точность, источники и права, язык, структура главы. Они действуют и здесь. Ниже — то, что специфично для численных методов. Как устроены файлы лекции и как работать с репозиторием — в quarto-guide.md и git-guide.md.

Воспроизводимость

  • Каждый численный результат воспроизводится кодом из репозитория. Рисунки строятся скриптами, ручная правка рисунков не допускается.
  • Результаты, зависящие от генератора случайных чисел, получают явный seed.
  • Указываются версии Python, NumPy, SciPy и других пакетов, от которых зависит результат; версия LightHit — для примеров из него.
  • Время выполнения приводится вместе с описанием машины и условий замера.

Проверка результата

  • Метод проверяется на задаче с известным ответом (аналитическое решение, предельный случай, закон сохранения) до применения там, где ответа нет.
  • Заявленный порядок точности подтверждается тестом сходимости: ошибка строится как функция шага, наклон сравнивается с теорией.
  • Устойчивость метода объясняется и демонстрируется: условие, при котором схема устойчива, и пример, где оно нарушено.
  • Различаются ошибка метода (дискретизации), ошибка округления и ошибка модели. Итоговое число сопровождается оценкой каждой из них.
  • Сравнение быстрого метода с эталоном указывает, что именно принято за эталон и какова его собственная точность.

Единицы и соглашения

Для каждой задачи указываются единицы, обозначения и знаковые соглашения, а также системы координат и нормировки преобразований Фурье и сферических гармоник (знак показателя экспоненты, множители \(2\pi\), фазовый множитель Кондона–Шортли).

Код в лекциях

  • Короткие фрагменты — на слайде; объёмный код — в ноутбуке или в shared/code/.
  • Один приём реализуется один раз и переиспользуется.
  • В тексте, слайдах и коде нет служебных комментариев, подсказок, промптов и отметок о способе генерации материала.