貢獻者快速入門指南#

從 GitHub 取得原始碼之後,有三個步驟可以開始貢獻

  1. 設定開發環境

    使用 mamba,或任何其他虛擬環境管理工具,您可以確保 SciPy 的開發版本不會干擾您機器上任何其他本地安裝的 SciPy。

  2. 建置 SciPy

    SciPy 為了速度使用編譯後的程式碼,這表示您可能需要額外的相依性才能完成此步驟,具體取決於您的系統 - 請參閱從原始碼建置

  3. 執行開發任務

    這些可以包括您想要對原始碼進行的任何變更、執行測試、建置文件、執行基準測試等等。

基本工作流程#

注意

我們強烈建議使用使用者啟動的環境設定,例如 conda 或虛擬環境。

由於 SciPy 包含以 C、C++ 和 Fortran 撰寫的部分,這些部分在使用前需要編譯,請確保您已安裝必要的編譯器和 Python 開發標頭檔。如果您使用 mamba,這些將會自動安裝。如果您使用 pip,請檢查您可能需要的系統層級相依性

首先,將 GitHub 上主 SciPy 儲存庫的分支複製到您自己的帳戶,然後透過以下方式建立您的本地儲存庫

git clone git@github.com:YOURUSERNAME/scipy.git scipy
cd scipy
git submodule update --init
git remote add upstream https://github.com/scipy/scipy.git

接下來,設定您的開發環境。系統層級相依性安裝完成後,執行從原始碼建置中的指示。

有關如何測試變更的詳細資訊,請參閱開發工作流程中更完整的設定逐步解說。

其他工作流程#

設定開發環境有很多種可能的方法。如需更詳細的說明,請參閱SciPy 貢獻者指南

注意

如果您在從原始碼建置 SciPy 或設定本地開發環境時遇到問題,您可以嘗試使用 GitHub Codespaces 建置 SciPy。它允許您直接在瀏覽器中建立正確的開發環境,減少安裝本地開發環境和處理不相容相依性的需求。

如果您有良好的網路連線能力並想要暫時性的設定,在 Codespaces 環境中處理 SciPy 通常會更快。有關如何開始使用 Codespaces 的文件,請參閱Codespaces 文件。為 scipy/scipy 儲存庫建立 codespace 時,預設的 2 核心機器類型即可運作;4 核心會建置和運作得更快一些(但當然會以減少一半的免費使用時數為代價)。一旦您的 codespace 啟動,您可以執行 conda activate scipy-dev,您的開發環境就完全設定好了 - 然後您可以按照 SciPy 文件的相關部分來建置、測試、開發、撰寫文件並貢獻 SciPy。

另一種替代方案是使用 Gitpod。我們不再維護此解決方案,但可以在我們文件的先前版本中找到一些資訊。