Project

General

Profile

Task #2359

r2018 docs tweaks/corrections necessary

Added by Szilárd Páll about 1 month ago. Updated 7 days ago.

Status:
Fix uploaded
Priority:
Normal
Assignee:
-
Category:
-
Target version:
Difficulty:
uncategorized
Close

Description

These are short notes compiled from the first glance, feel free to improve/add more.

  • Install guide
    - Add NVML to optional components, look through its other mentions.
    - Mention cuFFT in the FFT section.
    - "GPU support" overall facelift, Volta, etc.
    - SIMD: AVX2_128 missing; add hints on AVX_512 vs AVX2_256.
    - File names descriptions of builds (full/mdrun-only/MPI/prefixes).
    - Tested platforms: add Cray XC50+ThunderX2.
  • User guide
    - Review NB/cutoff schemes (tolerance, nstlist).
    - Examples of "-gputasks" are outdated in multiple spots, as initially it just replaced "-gpu_id" everywhere, including the docs, and only later started requiring all the other parameters to be specified.
    - "Good performance" best effort update.
    - Performance checklist update.
    - Clean up env.vars section (there be dinosaurs, Szilard has a WIP https://gerrit.gromacs.org/7375).
    - Some empty TODO sections at the end (?), like "Terminology".
  • Website
    - Figure out version's URLs, try to have a current version URL (e.g. manual.gromacs.org/documentation/current/index.html), remove the duplication of minor releases.
    - Make the overview versioning page http://manual.gromacs.org/documentation/ more user-friendly; have "up" links on the sub-pages.

Associated revisions

Revision 2fd09ca5 (diff)
Added by Szilárd Páll 14 days ago

Environment variable docs maintenance

Removed deprecated variables (some ancient, some recent), corrected some
misspelled ones.

Added undocumented environment variables.

Left a comment with handy one-liner to discover leftovers as well as
undocumented variables.

Refs #2359

Change-Id: Icb80cf661e2a53c5049fe18d687b987fb2c025f1

Revision d7d9b85f (diff)
Added by Szilárd Páll 14 days ago

Install guide updates

Updated install guide to reflect chnges in for the 2018 release.

Refs #2359

Change-Id: Ic679e7d7e96392c2c28185db1f71928146cd742d

Revision 01de2421 (diff)
Added by Szilárd Páll 13 days ago

User guide updates to GPU section

Refs #2359

Change-Id: Ied4945f83dc19f93a51aa78f51b7cea18021f5b8

History

#1 Updated by Mark Abraham about 1 month ago

  • Target version set to 2018

#2 Updated by Aleksei Iupinov about 1 month ago

  • Description updated (diff)

#3 Updated by Aleksei Iupinov about 1 month ago

  • Description updated (diff)

#4 Updated by Mark Abraham 21 days ago

Szilard has some WIP

#5 Updated by Gerrit Code Review Bot 19 days ago

Gerrit received a related patchset '3' for Issue #2359.
Uploader: Szilárd Páll ()
Change-Id: gromacs~release-2018~Icb80cf661e2a53c5049fe18d687b987fb2c025f1
Gerrit URL: https://gerrit.gromacs.org/7375

#6 Updated by Gerrit Code Review Bot 19 days ago

Gerrit received a related patchset '3' for Issue #2359.
Uploader: Szilárd Páll ()
Change-Id: gromacs~release-2018~Ic679e7d7e96392c2c28185db1f71928146cd742d
Gerrit URL: https://gerrit.gromacs.org/7429

#7 Updated by Gerrit Code Review Bot 19 days ago

Gerrit received a related DRAFT patchset '2' for Issue #2359.
Uploader: Szilárd Páll ()
Change-Id: gromacs~release-2018~Ied4945f83dc19f93a51aa78f51b7cea18021f5b8
Gerrit URL: https://gerrit.gromacs.org/7430

#8 Updated by Mark Abraham 19 days ago

Ill organize updates to the user guide. I can see some stubs that Paul added that should be removed in 2018 branch, and probably some re-ordering of content is in order, too.

#9 Updated by Mark Abraham 19 days ago

Also, I added the release notes to the repo and organize it to build RELEASENOTES plain text into the tarball. See https://gerrit.gromacs.org/#/c/7433/

#10 Updated by Mark Abraham 14 days ago

  • Status changed from New to Fix uploaded

#11 Updated by Mark Abraham 8 days ago

  • Target version changed from 2018 to 2018.1

I had a few patches that made it into version 2018 that addressed things that didn't reference this issue.

There's still an open question of how we want release notes to work and look on the webpage. https://gerrit.gromacs.org/#/c/7444/ adds those for all 2016.x. I can import the earlier ones in semi-bulk once we have some agreement on the approach.

Are there remaining thoughts people have for things to document / update for release 2018?

#12 Updated by Paul Bauer 8 days ago

I'm working on some more things for master (transferring stuff from the old pages), but I don't think those need to get in release-2018

#13 Updated by Gerrit Code Review Bot 7 days ago

Gerrit received a related patchset '1' for Issue #2359.
Uploader: Paul Bauer ()
Change-Id: gromacs~master~I474f4161003f07f92ba23d8183ac058fec4dc17b
Gerrit URL: https://gerrit.gromacs.org/7487

Also available in: Atom PDF