Beitragen
Atomsk nutzt die LAPACK-Bibliothek , deren Autoren herzlich gedankt werden.
Mein besonderer Dank gilt den folgenden Personen für ihre bedeutenden Beiträge zu Atomsk (Zugehörigkeiten entsprechen dem Zeitpunkt des ersten Beitrags):
- Juri Barthel, RWTH Aachen, Deutschland, für die Implementierung von Raumgruppen, das Hinzufügen von Dateiunterstützung zu CEL-Dateien, für die Verbesserung der Dateiunterstützung für CIF-Dateien und für die Übersetzung von Programmnachrichten ins Deutsche.
- Philippe Carrez, Universität Lille, Frankreich, für die Implementierung eines Modus zur Berechnung des Nye-Tensors.
- Emmanuel Clouet, CEA, Frankreich, für die Veröffentlichung seines Babel-Programms zum Aufbau von Versetzungsschleifen.
- Adham Hashibon, Fraunhofer-IWM, Freiburg, Deutschland, für den Gedankenaustausch und die Diskussion über die Implementierung verschiedener Methoden.
- Eva Marie Kalivoda, Fraunhofer-IWM, Freiburg, Deutschland, für die Implementierung der XV-Format-Dateiunterstützung von SIESTA .
- Srinivasan Mahendran, Universität Lille, Frankreich, für seine Hilfe bei der Implementierung eines Zellzerlegungsalgorithmus, der die Nachbarsuche beschleunigt.
- Matous Mrovec, Fraunhofer-IWM, Freiburg, Deutschland, für seine Hilfe bei der Implementierung anisotroper Elastizität für Gebäudeversetzungen.
Abschließend danke ich den Bug-Jägern, deren Beiträge dazu beigetragen haben, die Zuverlässigkeit und Genauigkeit des Programms zu verbessern:
- Jonathan Amodeo, MATEIS, Univ. Lyon 1, France.
- Pietro Bonfa', Uni. Parma, Italy.
- Marion Borde, MATEIS, Univ. Lyon 1, France.
- Peixin Chen, Shanghai Jiao Tong University, China.
- Sen Chen, The Peac Institute of Multiscale Sciences (PIMS), Chengdu, China.
- Jaroslaw Czernek, IMC, Prague, Czech Republic.
- Valentin Delbecq, UMET, Univ. Lille, France.
- Jérôme Dequeker, UMET, Univ. Lille, France.
- Davide Di Stefano, Fraunhofer-IWM, Freiburg, Germany.
- Yann Even, MATEIS, Lyon, France.
- Jan Fikar, Institute of Physics of Materials ASCR, Brno, Czech Republic.
- Jean Furstoss, UMET, Univ. Lille, France.
- Nils Garvik, UMET, Univ. Lille, France.
- Alexandra Goryaeva, INSA Lyon, France.
- Karine Gouriet, University of Lille, France.
- Roman Gröger, Institute of Physics of Materials, Czech Academy of Sciences, Czech Republic.
- Julien Guénolé, IPMP, RWTH Aachen, Germany.
- Ling-Ju Guo, National Center for Nanoscience and Technology, Beijing, China.
- Lubin Huo, Ningbo Institute of Materials Technology and Engineering, China.
- Yaron Kauffmann, Technion, Israel.
- Vasiliy Krasnikov, South-Ural State University, Chelyabinsk, Russia.
- Antoine Kraych, CEA, France.
- Wei Li, University of Hong-Kong, China.
- Hui Liu, McGill University, Montreal, Canada.
- Dario Marrocchelli, MIT, Boston, USA.
- Marcin Minkowsky, Tampere University, Finland.
- Samaneh Nasiri, Friedrich-Alexander-University Erlangen-Nürnberg, Germany.
- Raoul Aurelien Ngayam Happy, Paul Sherrer Institute, Switzerland.
- Dongho Nguimdo Moise, AIMS, Cameroon.
- Justin Ondry, UC Berkeley, USA.
- Anirban Pal, Rensselaer Polytechnic Institute, Troy (NY), USA.
- Sebastian Ritterbex, UMET, Univ. Lille, France.
- Davide Sangiovanni, Linköping University, Sweden.
- Min Shi, University of Minnesotta, USA.
- Eerik Voimanen, Tampere University, Finland.
- Yanzhou Wang, Aalto University, Finland.
- Michael Wolloch, University of Modena and Reggio Emilia, Italy.
- Jianyang Wu, Xiamen University, China.
- Zhuocheng Xie, RWTH Aachen, Germany.
- Zheyuan Xing, Southwest Jiaotong University, China.
- Jian-Hui Zhai, UMET, Univ. Lille, France.
- Yong Zhang, Monash University, Clayton, Australia.
- Benedikt Ziebarth, Fraunhofer-IWM, Freiburg, Germany.
Möchten Sie einen Beitrag leisten?
Atomsk kann in vielerlei Hinsicht noch verbessert werden. Wenn Sie einen Beitrag leisten möchten, können Sie den Quellcode ändern, um einen Fehler zu beheben, eine Routine zu optimieren, eine neue Funktion hinzuzufügen oder Übersetzungen der Nachrichten zu ändern oder hinzuzufügen. Sie können die Atomsk-Dokumentation auch übersetzen, sodass Benutzer sie in ihrer Muttersprache lesen können. Ihre Beiträge sind willkommen!
Melde einen technischen Fehler
Wenn Sie beim Ausführen von Atomsk einen Fehler gefunden haben, können Sie einen Bericht auf GitHub öffnen oder den Autor direkt per E-Mail kontaktieren.
Ein „Bug“ kann jede Art von unerwünschtem Verhalten sein: ein falsches oder inkonsistentes Ergebnis, eine schlechte Übersetzung, ein Absturz oder ein Segfault. Wenn Sie einen Fehlerbericht einreichen, geben Sie bitte an, welche Version von Atomsk Sie verwenden und welchen Befehl dieser Fehler verursacht. Erklären Sie nach Möglichkeit auch, welches Ergebnis Sie erwarten und warum Sie denken, dass das von Atomsk erzeugte Ergebnis falsch ist.
Verwenden Sie Git und Github
Atomsk wird mit Git entwickelt und die Entwicklung wird auf der GitHub-Site veröffentlicht. Um zu erfahren, wie man Git (den Release Manager selbst) und Github (die Plattform, auf der Atomsk gehostet wird) verwendet, können die folgenden Links ein guter Anfang sein:
Fordern Sie auch gerne weitere Informationen und Anleitungen bei Ihrer bevorzugten Suchmaschine an.
So tragen Sie zu Atomsk bei
Wenn Sie zu Atomsk beitragen möchten, gehen Sie folgendermaßen vor:
- Erstellen Sie Ihr eigenes Konto auf GitHub.com. Bitte verwenden Sie Ihren echten Vor- und Nachnamen (und kein Pseudonym).
- Gehen Sie zur Atomsk-GitHub-Seite und klicken Sie auf die Schaltfläche „Fork“. Dadurch wird eine Kopie von Atomsk auf Ihrem GitHub-Konto erstellt.
- Schauen Sie sich Ihre Kopie auf Ihrem lokalen Computer an, wie Sie es bei jedem GitHub-Repository tun würden:
git clone https://github.com/mon_nom/mon_depot
- Anstatt direkt an Ihrem Hauptzweig „Master“ zu arbeiten (was zu Konflikten führen könnte), ist es jetzt sicherer, einen eigenen separaten Zweig zu erstellen:
git checkout -b ma_branche
- Arbeiten Sie an Ihrer eigenen Kopie von Atomsk und ändern Sie die Dateien nach Ihren Wünschen. Kompilieren Sie Ihre Version, um sicherzustellen, dass Ihre Änderungen ordnungsgemäß funktionieren. Vergessen Sie nicht, Kommentare in Ihren Quellcode aufzunehmen.
- Sobald Ihre Arbeit erledigt ist, übernehmen Sie Ihre Änderungen (mit Kommentaren!):
git commit -a
Schieben Sie sie dann in Ihr GitHub-Repository:
git push origin ma_branche
Git fragt dann nach Ihren GitHub-Anmeldeinformationen.
- Öffnen Sie Ihren Webbrowser, gehen Sie zur GitHub-Seite Ihres Repositorys und klicken Sie auf die Schaltfläche „Pull request“.
Ihre Änderungen werden dem Hauptautor als Pull-Anfrage angezeigt. Nachdem Sie Ihre Änderungen überprüft haben, kann der Hauptautor diese akzeptieren und in die Hauptversion von Atomsk einbinden (oder auch nicht).
Senden Sie eine bearbeitete Version per E-Mail
Wenn Sie GiHub nicht nutzen können oder wollen, können Sie Ihre bearbeitete Version direkt per E-Mail versenden. Bitte archivieren Sie in diesem Fall Ihre gesamte geänderte Version von Atomsk (im ZIP- oder TAR.GZ-Format), bevor Sie sie senden. Wenn möglich oder relevant, können Sie auch Skripte einreichen, die die von Ihnen vorgenommenen Änderungen veranschaulichen.
Wichtig: Nutzungs- und Verhaltensregeln
Beiträge sind willkommen. Beiträge sind in Ordnung. Damit es aber nicht chaotisch wird, respektieren Sie bitte die folgenden Etikette-Regeln, wenn Sie zu Atomsk beitragen.
- Verwenden Sie Ihren richtigen Namen und Ihre Zugehörigkeit auf GitHub. Als Hauptautor habe ich mehr Vertrauen in einen Beitrag, wenn ich weiß, woher er kommt. Besser noch: Senden Sie mir eine E-Mail von Ihrer Arbeitsadresse, wenn Sie eine Pull-Anfrage stellen. Wir freuen uns immer über E-Mails (siehe Kontaktseite). Wenn Sie ein Pseudonym oder eine unprofessionelle Adresse verwenden, wirkt Ihr Beitrag verdächtig, die Überprüfung dauert länger und die Wahrscheinlichkeit einer Ablehnung steigt.
- Kontaktieren Sie den leitenden Entwickler, bevor Sie mit der Programmierung beginnen. Dadurch weiß der Hauptentwickler, an welchen Teilen des Codes gerade gearbeitet wird, sodass nicht mehrere Personen an derselben Sache arbeiten. Sie sollten entweder Ihre Absichten beschreiben, indem Sie auf der GitHub-Seite des Projekts auf die Schaltfläche „Probleme“ klicken, oder eine E-Mail an den Hauptentwickler senden (siehe Kontaktseite) .
- Kommentieren und kommentieren. Kommentieren Sie Ihren Quellcode. Kommentieren Sie Ihre Commits. Dies hilft sehr dabei, zu verstehen, was getan wurde, und die Überprüfung Ihres Beitrags wird beschleunigt. Wenn es keine Kommentare gibt (oder unnötige oder schlecht formulierte Kommentare), muss der Hauptautor mehr Zeit damit verbringen, die Änderungen im Quellcode zu verstehen, warum sie geändert wurden und wie sie sich auf das Verhalten des Programms auswirken.
- Stellen Sie sicher, dass Ihre Version kompiliert wird, bevor Sie einen Pull anfordern. Wenn Ihre Version nicht kompiliert werden kann, ist Ihre Arbeit noch nicht abgeschlossen: Sie müssen Ihre Änderungen nicht senden, sie werden nicht akzeptiert!
- Stellen Sie sicher, dass die Dokumentation mit Ihren Änderungen übereinstimmt. Für Fehlerbehebungen ist keine Änderung der Dokumentation erforderlich. Wenn Sie jedoch einige Funktionen ändern oder neue hinzufügen, ändern Sie bitte auch die Dokumentation (im Ordner /doc/), damit Ihre Änderungen darin berücksichtigt werden. Wenn Ihre Ergänzungen nicht in der Dokumentation beschrieben sind, wird praktisch niemand von dieser Funktion erfahren und niemand wird sie nutzen.
