编写良好研究代码的最佳实践

1. 项目介绍

本项目是基于开源仓库research_code的教程，该项目由Patrick Mineault创建，旨在分享关于编写不会反咬你的研究软件的经验。这个仓库包含了作者在一次哈佛神经学博士生演讲中使用的幻灯片和代码，汇集了关于编写研究代码的五个宝贵教训。

2. 项目快速启动

要本地启动该项目，请按照以下步骤操作：

首先，确保你已经安装了Python环境。然后，克隆仓库到本地：

git clone https://github.com/patrickmineault/research_code.git

接着，进入项目目录，并安装项目依赖：

cd research_code
pip install -r requirements.txt

为了在本地开发模式下安装Python包，执行以下命令：

pip install -e .

在Python代码中，你可以这样导入项目：

import research_code

要运行测试，请进入research_code/tests目录，然后逐个运行测试文件，或者使用nose2运行所有测试。

3. 应用案例和最佳实践

本项目提倡以下最佳实践：

• 代码组织：仓库遵循shablona的组织结构，所有代码和测试都在research_code目录下，该目录本身是一个Python包。
• 持续集成：项目使用GitHub Actions进行CI，不需要额外的账户或软件。CI工作流定义在.github/workflows/ci.yml中。
• 代码测试：测试应该涵盖所有重要的功能，确保代码的稳定性和可靠性。
• 文档：编写清晰的文档，帮助其他开发者理解和使用你的代码。

4. 典型生态项目

本项目可以作为研究代码编写的典型案例，适用于需要编写高质量、可维护性研究代码的学术和研究项目。它的结构清晰，遵循了现代软件开发的最佳实践，包括代码的组织、测试和持续集成。通过学习和应用这些实践，研究者和开发者可以编写出更健壮、更易于理解的代码。