Schnellstartanleitung für Mitwirkende#

Nachdem Sie den Quellcode von GitHub bezogen haben, gibt es drei Schritte, um mit der Mitwirkung zu beginnen

  1. Entwicklungsumgebung einrichten

    Mit Hilfe von mamba oder einer anderen beliebigen virtuellen Umgebungsmanagement-Tool können Sie sicherstellen, dass die Entwicklungsvariante von SciPy nicht mit anderen lokalen Installationen von SciPy auf Ihrem Rechner kollidiert.

  2. SciPy kompilieren

    SciPy verwendet kompilierten Code für Geschwindigkeit, was bedeutet, dass Sie möglicherweise zusätzliche Abhängigkeiten benötigen, um diesen Schritt abzuschließen, abhängig von Ihrem System – siehe Kompilieren aus dem Quellcode.

  3. Entwicklungsaufgaben durchführen

    Dies kann beliebige Änderungen am Quellcode, das Ausführen von Tests, das Erstellen der Dokumentation, das Ausführen von Benchmarks usw. umfassen.

Grundlegender Workflow#

Hinweis

Wir empfehlen dringend die Verwendung einer benutzeraktivierten Umgebungsaufstellung, wie z. B. einer Conda- oder virtuellen Umgebung.

Da SciPy Teile in C, C++ und Fortran enthält, die vor der Verwendung kompiliert werden müssen, stellen Sie sicher, dass Sie die erforderlichen Compiler und Python-Entwicklungsheader installiert haben. Wenn Sie mamba verwenden, werden diese automatisch installiert. Wenn Sie pip verwenden, überprüfen Sie, welche systemweiten Abhängigkeiten Sie möglicherweise benötigen.

Zuerst forken Sie eine Kopie des Haupt-SciPy-Repositorys auf GitHub in Ihr eigenes Konto und erstellen dann Ihr lokales Repository über

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

Als Nächstes richten Sie Ihre Entwicklungsumgebung ein. Mit installierten systemweiten Abhängigkeiten führen Sie die Anweisungen unter Kompilieren aus dem Quellcode aus.

Details zur Testung Ihrer Änderungen finden Sie im vollständigeren Einrichtungs-Walkthrough unter Entwicklungsworkflow.

Andere Workflows#

Es gibt viele Möglichkeiten, Ihre Entwicklungsumgebung einzurichten. Detailliertere Anleitungen finden Sie im Handbuch für SciPy-Mitwirkende.

Hinweis

Wenn Sie Schwierigkeiten haben, SciPy aus dem Quellcode zu kompilieren oder Ihre lokale Entwicklungsumgebung einzurichten, können Sie versuchen, SciPy mit GitHub Codespaces zu kompilieren. Dies ermöglicht es Ihnen, die richtige Entwicklungsumgebung direkt in Ihrem Browser zu erstellen, wodurch die Notwendigkeit, lokale Entwicklungsumgebungen zu installieren und mit inkompatiblen Abhängigkeiten umzugehen, reduziert wird.

Wenn Sie eine gute Internetverbindung haben und eine temporäre Einrichtung wünschen, ist es oft schneller, an SciPy in einer Codespaces-Umgebung zu arbeiten. Anleitungen für den Einstieg in Codespaces finden Sie in der Codespaces-Dokumentation. Beim Erstellen eines Codespace für das Repository scipy/scipy funktioniert der Standard-Maschinentyp mit 2 Kernen; 4 Kerne kompilieren und arbeiten etwas schneller (kostet aber natürlich die Hälfte Ihrer kostenlosen Nutzungsstunden). Sobald Ihr Codespace gestartet ist, können Sie conda activate scipy-dev ausführen und Ihre Entwicklungsumgebung ist vollständig eingerichtet – Sie können dann die relevanten Teile der SciPy-Dokumentation befolgen, um SciPy zu kompilieren, zu testen, zu entwickeln, Dokumente zu schreiben und zu SciPy beizutragen.

Eine weitere Alternative ist die Verwendung von Gitpod. Wir pflegen diese Lösung nicht mehr, aber einige Informationen finden Sie in früheren Versionen unserer Dokumentation.