Contribuar
Atomsk utiliza la biblioteca LAPACK, cuyos autores agradecemos calurosamente.
Dirijo un agradecimiento especial a las siguientes personas, por sus importantes contribuciones a Atomsk (las afiliaciones corresponden al momento de la primera contribución):
- Juri Barthel, RWTH Aachen, Alemania, por implementar grupos espaciales, agregar soporte de archivos a CEL filesarchivos CEL, mejorar el soporte de archivos a archivos CIF y traducir mensajes de programa al alemán.
- Philippe Carrez, Universidad de Lille, Francia, por implementar un modo de cálculo del tensor de Nye.
- Emmanuel Clouet, CEA, Francia, por compartir su programa Babel para construir bucles de dislocación.
- Adham Hashibon, Fraunhofer-IWM, Freiburg, Alemania, por el intercambio de ideas y discusiones sobre la implementación de varios métodos.
- Eva Marie Kalivoda, Fraunhofer-IWM, Freiburg, Alemania, por implementar el soporte de archivos de formato XV de SIESTA.
- Srinivasan Mahendran, Universidad de Lille, Francia, por su ayuda en la implementación de un algoritmo de descomposición de celdas que agiliza la búsqueda de vecinos.
- Matous Mrovec, Fraunhofer-IWM, Freiburg, Alemania, por su ayuda en la implementación de la elasticidad anisotrópica para las dislocaciones de edificios.
Finalmente, agradezco a los cazadores de errores, cuyas publicaciones ayudaron a mejorar la confiabilidad y precisión del programa:
- 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.
¿Quieres contribuir?
Atomsk todavía se puede mejorar de muchas maneras. Si desea contribuir, puede modificar el código fuente para corregir un error, optimizar una rutina, agregar una nueva función o modificar o agregar traducciones de los mensajes. También puede traducir la documentación de Atomsk, para que los usuarios puedan leerla en su idioma nativo. ¡Sus contribuciones son bienvenidas!
Reportar un error
Si encontró un error mientras ejecutaba Atomsk, puede abrir un informe en GitHub o comunicarse directamente con el autor por correo electrónico.
Un "error" puede ser cualquier tipo de comportamiento no deseado: un resultado incorrecto o incoherente, una mala traducción, un bloqueo o una falla de segmento. Al enviar un informe de error, indique qué versión de Atomsk está utilizando y el comando que produce este error. Además, si es posible, explique qué resultado espera obtener y por qué cree que el resultado producido por Atomsk es incorrecto.
Usa Git y Github
Atomsk se desarrolla utilizando Git y el desarrollo se hace público en el sitio de GitHub. Para aprender a usar git (el administrador de versiones en sí) y cómo usar Github (la plataforma que aloja Atomsk), los siguientes enlaces pueden ser un buen comienzo:
También siéntase libre de solicitar más información y tutoriales de su motor de búsqueda favorito.
Cómo contribuir a Atomsk
Si desea contribuir con Atomsk, siga estos pasos:
- Crea tu propia cuenta en GitHub.comGitHub.com. Utilice su nombre y apellido reales (y no un seudónimo).
- Vaya a la página de Atomsk GitHub y haga clic en el botón "Fork"; esto creará una copia de Atomsk en su cuenta de GitHub.
- Consulte su copia en su computadora local, como lo haría con cualquier repositorio de GitHub:
git clone https://github.com/mon_nom/mon_depot
- Ahora, en lugar de trabajar directamente en su rama "maestra" principal (que podría crear conflictos), es más seguro crear su propia rama separada:
git checkout -b ma_branche
- Trabaje en su propia copia de Atomsk, modifique los archivos como desee. Compile su versión para verificar que sus cambios funcionan bien. No olvide incluir comentarios en su código fuente.
- Una vez que haya terminado su trabajo, confirme sus cambios (¡con comentarios!):
git commit -a
Luego, introdúzcalos en su repositorio de GitHub:
git push origin ma_branche
Git luego le pide sus credenciales de GitHub.
- Abra su navegador web, vaya a la página de GitHub de su repositorio y haga clic en el botón "Pull request".
Tus cambios aparecerán para el autor principal como una solicitud de incorporación de cambios. Después de verificar sus cambios, el autor principal puede aceptarlos y fusionarlos en la versión principal de Atomsk (o no).
Enviar una versión editada por correo electrónico
Si no puede o no quiere usar GiHub, puede enviar su versión editada por correo electrónico directamente. En este caso, archive toda la versión modificada de Atomsk (en formato zip o tar.gz) antes de enviarla. Si es posible o relevante, también puede enviar guiones que ilustren los cambios que ha realizado.
Importante: normas de uso y buena conducta
Las contribuciones son bienvenidas. Las contribuciones están bien. Pero para evitar que sea caótico, respete las pocas reglas de etiqueta a continuación cuando contribuya a Atomsk.
- Use su nombre real y afiliación en GitHub. Como autor principal, tengo más confianza en una contribución si sé de dónde viene. Mejor aún: envíeme un correo electrónico desde su dirección de trabajo cuando realice una solicitud de extracción. Siempre se agradecen los correos electrónicos (consulte la página de contacto). Si usa un seudónimo o una dirección poco profesional, su contribución parecerá sospechosa, llevará más tiempo verificarla y es más probable que sea rechazada.
- Póngase en contacto con el desarrollador principal antes de comenzar a programar. Esto le permite al desarrollador principal saber en qué partes del código se está trabajando, de modo que varias personas no trabajen en lo mismo. Debe describir sus intenciones haciendo clic en el botón "Problemas" en la página de GitHub del proyecto, o enviar un correo electrónico al desarrollador principal (consulte la página de contacto).
- Comenta y comenta. Comenta tu código fuente. Comenta tus compromisos. Esto ayuda mucho a entender lo que se ha hecho, y se acelerará la verificación de tu aporte. Cuando no hay comentarios (o comentarios innecesarios o mal redactados), el autor principal debe dedicar más tiempo a comprender los cambios en el código fuente, por qué se modificó y cómo afecta el comportamiento del programa.
- Asegúrese de que su versión se compile antes de solicitar una extracción. Si su versión no compila, entonces su trabajo no está terminado: no es necesario que envíe sus modificaciones, ¡no serán aceptadas!
- Asegúrese de que la documentación esté de acuerdo con sus cambios. Las correcciones de errores no requieren cambiar la documentación. Sin embargo, si modifica algunas funciones o agrega otras nuevas, modifique también la documentación (en la carpeta /doc/) para que incorpore sus modificaciones. Si sus adiciones no se describen en la documentación, prácticamente nadie sabrá acerca de esta característica y nadie la usará.
