Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More Programmer Guide and Library Interface updates for next release #2413

Merged
merged 41 commits into from Oct 9, 2020

Conversation

akohlmey
Copy link
Member

@akohlmey akohlmey commented Oct 9, 2020

Summary

This contains various updates to the Programmer Guide, the library interfaces, the python module, CMake scripts, and the LAMMPS shell in preparation for the stable release.

Author(s)

Axel Kohlmeyer, Temple U

Licensing

By submitting this pull request, I agree, that my contribution will be included in LAMMPS and redistributed under either the GNU General Public License version 2 (GPL v2) or the GNU Lesser General Public License version 2.1 (LGPL v2.1).

Backward Compatibility

The -DLAMMPS_LIB_NO_MPI has been replaced with -DLAMMPS_LIB_MPI and the meaning is now reversed.

Implementation Notes

Individual changes are:

  • the LAMMPS shell prints now OS/Compiler information when starting and has a new "mem" command.
  • various minor reorganizations and corrections in the documentation of the C-library interface
  • add and document missing C-library functions in the Python module
  • consolidate two redundant sections documenting the building of the manual.
  • various minor tweaks to the documentation
  • improve formatting of the description of the reax/c control file
  • Move tools and LAMMPS shell build target code to separate Tools.cmake file
  • Add a few more useful outputs to the CMake configuration summary
  • Print warning when reading positions from a data file with non-zero image flags to non-periodic dimensions

Post Submission Checklist

  • The feature or features in this pull request is complete
  • Licensing information is complete
  • Corresponding author information is complete
  • The source code follows the LAMMPS formatting guidelines
  • Suitable new documentation files and/or updates to the existing docs are included
  • The added/updated documentation is integrated and tested with the documentation build system
  • The feature has been verified to work with the conventional build system
  • The feature has been verified to work with the CMake based build system
  • Suitable tests have been added to the unittest tree.
  • A package specific README file has been included or updated

@akohlmey akohlmey added the cmake label Oct 9, 2020

pip3 install virtualenv
pip3 install virtualenv
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should think about updating this to the venv module that is part of Python 3. That way we avoid having to install virtualenv.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

won't be able to do this in this PR. too many ripples.

@@ -1,6 +1,7 @@
// unit tests creating LAMMPS instances via the library interface

#include "lammps.h"
#define LAMMPS_LIB_MPI 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

@akohlmey akohlmey marked this pull request as ready for review October 9, 2020 21:29
@akohlmey akohlmey merged commit 0460dc3 into lammps:master Oct 9, 2020
@akohlmey akohlmey deleted the progguide-updates branch October 17, 2020 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants