diff --git a/doc/src/Modify.rst b/doc/src/Modify.rst index 31e67a66ca..38cf58cbf5 100644 --- a/doc/src/Modify.rst +++ b/doc/src/Modify.rst @@ -1,18 +1,22 @@ Modifying & extending LAMMPS **************************** -LAMMPS is designed in a modular fashion and to be easy to modify or -extend with new functionality. In fact, about 95% of its source code +LAMMPS is designed in a modular fashion and easy to be modified or +extended with new functionality. In fact, about 95% of its source code is optional. The following pages give basic instructions on adding new -features to LAMMPS. +features to LAMMPS. More in-depth explanations and documentation of +individual functions and classes are given in :doc:`Developer`. If you add a new feature to LAMMPS and think it will be of general interest to other users, we encourage you to submit it for inclusion in LAMMPS. This process is explained in the following three pages: :doc:`how to prepare and submit your code `, :doc:`requirements for submissions `, and -:doc:`style guidelines `. A discussion of the various -types of styles in LAMMPS is then provided. +:doc:`style guidelines `. + +A summary description of various types of styles in LAMMPS follows. +A discussion of implementing specific styles from scratch is given +in :doc:`Developer_write`. .. toctree:: diff --git a/doc/src/Modify_requirements.rst b/doc/src/Modify_requirements.rst index 8c5869c929..8c50bea94e 100644 --- a/doc/src/Modify_requirements.rst +++ b/doc/src/Modify_requirements.rst @@ -1,7 +1,6 @@ Requirements for contributions to LAMMPS =========================================================== - The following is a summary of the current requirements and recommendations for including contributed source code or documentation into the LAMMPS software distribution. @@ -41,6 +40,7 @@ include: .. _License: + Licensing requirements (strict) ------------------------------- @@ -69,8 +69,8 @@ that use code with a conflicting license can be split into two parts: Please note, that this split licensed mode may complicate including the contribution in binary packages. +.. _IntegrationTesting: -.. _IntegrationTesting Integration testing (strict) ---------------------------- @@ -95,7 +95,8 @@ testing tools or scripts or tests themselves. This is rare. If in doubt, contact the LAMMPS developer that is assigned to the pull request. -.. _Documentation +.. _Documentation: + Documentation (strict) ---------------------- diff --git a/doc/src/Modify_style.rst b/doc/src/Modify_style.rst index 2603df8242..41f7748e9f 100644 --- a/doc/src/Modify_style.rst +++ b/doc/src/Modify_style.rst @@ -1,5 +1,5 @@ LAMMPS programming style -=========================================================== +======================== The LAMMPS developers aim to employ a consistent programming style and @@ -15,7 +15,7 @@ may serve as representative examples. Include files (varied) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ - system headers or from installed libraries are include with angular brackets (example: ``#include ``), while local include file @@ -141,8 +141,7 @@ Miscellaneous standards (varied) scripts for interpreted script languages. Whitespace (preferred) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - +^^^^^^^^^^^^^^^^^^^^^^ LAMMPS uses 2 characters per indentation level and lines should be kept within 100 characters wide. @@ -165,7 +164,7 @@ issues. Placement of braces (strongly preferred) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On new lines for methods, when to use, etc.