AiZynthFinder社区贡献指南从问题报告到代码提交【免费下载链接】aizynthfinderA tool for retrosynthetic planning项目地址: https://gitcode.com/gh_mirrors/ai/aizynthfinderAiZynthFinder是一款强大的 retrosynthetic planning 工具基于蒙特卡洛树搜索算法能够递归分解分子结构以找到可购买的前体。该工具支持多种搜索算法和扩展策略完全可定制化是化学合成领域研究者的得力助手。为什么参与AiZynthFinder社区贡献 参与开源项目贡献不仅能提升个人技能还能为科学研究工具的发展贡献力量。AiZynthFinder社区欢迎各种形式的贡献无论是报告bug、提出功能建议还是提交代码改进都能帮助工具变得更完善。AiZynthFinder的核心功能架构在开始贡献前了解项目的核心架构有助于更好地理解代码结构。AiZynthFinder的主要组件包括搜索树、反应树、评分系统和库存管理等它们之间的关系如下AiZynthFinder核心组件关系图工作流程概览AiZynthFinder的工作流程从树搜索开始经过树分析、路径收集最终生成反应树。以下序列图展示了主要步骤AiZynthFinder工作流程序列图贡献的第一步环境准备 ⚙️1. 克隆仓库首先克隆AiZynthFinder仓库到本地git clone https://gitcode.com/gh_mirrors/ai/aizynthfinder2. 搭建开发环境推荐使用conda创建独立环境确保依赖兼容性conda env create -f env-dev.yml conda activate aizynth-dev poetry install --all-extras这样就完成了开发环境的搭建aizynthfinder包将以可编辑模式安装。如何报告问题或提出建议 如果您在使用过程中遇到bug或有功能改进建议请通过以下步骤提交issue访问项目的issue页面无需外部链接可在仓库内找到选择合适的issue模板bug报告或功能请求详细描述问题复现步骤预期行为实际行为环境信息系统、Python版本等对于bug报告建议附上错误日志和截图以便开发者更快定位问题。代码贡献完整流程 ‍1. Fork仓库并创建分支Fork项目仓库到您的个人账号克隆您的fork到本地创建新分支进行开发git checkout -b feature/your-feature-name或修复buggit checkout -b fix/bug-description2. 代码开发与规范在开发过程中请遵循以下规范使用black工具进行代码格式化遵循PEP8风格指南为新功能添加测试用例位于tests/目录更新相关文档位于docs/目录3. 运行测试确保您的代码通过所有测试pytest -v对于完整的CI测试可以运行invoke full-tests4. 提交与推送提交代码时请使用清晰的提交信息git commit -m Add feature: xxx git push origin your-branch-name5. 创建Pull Request在GitHub上创建Pull Request时请填写PR模板描述您的更改关联相关的issue确保CI检查通过贡献示例添加新的扩展策略 假设您想为AiZynthFinder添加一种新的扩展策略可以按照以下步骤进行在plugins/目录下创建新的策略文件例如new_strategy.py实现扩展策略类继承自ExpansionStrategy在配置文件中添加新策略的配置选项添加测试用例到tests/context/test_expansion_strategies.py更新文档说明新策略的使用方法图形界面功能贡献 ️AiZynthFinder提供了用户友好的图形界面您可以通过aizynthapp命令启动AiZynthFinder GUI输入界面如果您想改进GUI功能可以关注aizynthfinder/interfaces/gui/目录下的代码。例如您可以添加新的可视化选项或优化聚类分析功能AiZynthFinder聚类分析界面文档贡献 完善的文档对用户和开发者都非常重要。您可以通过以下方式贡献文档改进现有教程添加新功能的使用示例完善API文档字符串修复文档中的错误文档源代码位于docs/目录使用Sphinx生成HTML文档invoke build-docs社区交流与支持 虽然贡献者的支持时间有限但您可以通过提交issue获得帮助。在提问时请提供详细的上下文信息描述您已经尝试过的解决方法清晰表达您的问题或需求总结通过本指南您已经了解了如何从报告问题到提交代码全面参与AiZynthFinder社区贡献。无论您是初学者还是有经验的开发者您的每一份贡献都将帮助AiZynthFinder变得更好。AiZynthFinder搜索结果界面开始您的贡献之旅吧【免费下载链接】aizynthfinderA tool for retrosynthetic planning项目地址: https://gitcode.com/gh_mirrors/ai/aizynthfinder创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考