ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

as a few details to the discussion of programming languages and their standards

Browse Source
This commit is contained in:
Axel Kohlmeyer
2023-05-12 15:45:55 -04:00
parent cd79276309
commit 96af466f4a
1 changed files with 22 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/src/Modify_requirements.rst
View File

@ -168,29 +168,38 @@ Programming language standards (strict)
The core of LAMMPS is written in C++11 in a style that can be mostly The core of LAMMPS is written in C++11 in a style that can be mostly
described as "C with classes". Advanced C++ features like operator described as "C with classes". Advanced C++ features like operator
overloading or excessive use of templates are avoided with the intent overloading or excessive use of templates are avoided with the intent to
to keep the code readable to programmers that have limited C++ keep the code readable to programmers that have limited C++ programming
programming experience. C++ constructs are acceptable when they help experience. C++ constructs are acceptable when they help improve the
improve the readability and reliability of the code, e.g. when using readability and reliability of the code, e.g. when using the
the `std::string` class instead of manipulating pointers and calling `std::string` class instead of manipulating pointers and calling the
the string functions of the C library. In addition, a collection of string functions of the C library. In addition, a collection of
convenient :doc:`utility functions and classes <Developer_utils>` for convenient :doc:`utility functions and classes <Developer_utils>` for
recurring tasks and a collection of :doc:`platform neutral functions recurring tasks and a collection of :doc:`platform neutral functions
<Developer_platform>` for improved portability are provided. <Developer_platform>` for improved portability are provided.
Contributions with code requiring more recent C++ standards are only
accepted as packages with the post C++11 standard code confined to the
package so that it is optional.
Included Fortran code has to be compatible with the Fortran 2003 Included Fortran code has to be compatible with the Fortran 2003
standard. Python code must be compatible with Python 3.5. Large standard. Since not all platforms supported by LAMMPS provide good
parts of LAMMPS (including the :ref:`PYTHON package <PKG-PYTHON>`) are support for compiling Fortran files, it should be considered to rewrite
also compatible with Python 2.7. Compatibility with Python 2.7 is these parts as C++ code, if possible and thus allow for a wider adoption
desirable, but compatibility with Python 3.5 is **required**. of the contribution. As of January 2023, all previously included
Fortran code for the LAMMPS executable has been replaced by equivalent
C++ code.
Compatibility with these older programming language standards is very Python code must be compatible with Python 3.5 and later. Large parts
of LAMMPS (including the :ref:`PYTHON package <PKG-PYTHON>`) are also
compatible with Python 2.7. Compatibility with Python 2.7 is desirable,
but compatibility with Python 3.5 is **required**.
Compatibility with older programming language standards is very
important to maintain portability and availability of LAMMPS on many important to maintain portability and availability of LAMMPS on many
platforms. This applies especially to HPC cluster environments, which platforms. This applies especially to HPC cluster environments, which
tend to be running older software stacks and where LAMMPS users may be tend to be running older software stacks and where LAMMPS users may be
required to use those older tools for access to advanced hardware required to use those older tools for access to advanced hardware
features or not have the option to install newer compilers or features or not have the option to install newer compilers or libraries.
libraries.
.. _ReqBuildSystem: .. _ReqBuildSystem: