Упаковка кода Python для научного ПО

Оригинал статьи Jo Bovy: Python code packaging for scientific software от 10-11-2020.

(последнее изменение: 10 ноября 2020 г., ред. 09aec31; последнее изменение - 4 февраля 2021 г.)

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

PDF-версия этих заметок доступна здесь.

Содержание:

1. Введение: что делает хороший научный программный пакет?

2. Базовая структура пакета Python

3. git и GitHub: контроль версий и социальная разработка с открытым исходным кодом

4. Документирование кода и размещение документации в Интернете

5. Тестирование вашего кода

6. Автоматическое построение и тестирование вашего кода: непрерывная интеграция

7. Выпуск вашего пакета

Все фрагменты кода и примеры в этих примечаниях распространяются по лицензии CC0 1.0 Public Domain, поэтому вы можете повторно использовать и смешивать их в своей собственной работе. В противном случае текст предоставляется в соответствии с международной лицензией Creative Commons CC BY-NC-ND 4.0, что означает, что вы можете распространять произведение только полностью, вам не разрешается изменять его каким-либо образом, и вы не можете использовать его в коммерческих целях. означает или получить денежную компенсацию (обратите внимание, что это резюме не заменяет полные условия лицензии).