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

VASP main page updates #502

Merged
merged 13 commits into from
Oct 3, 2023
Merged

VASP main page updates #502

merged 13 commits into from
Oct 3, 2023

Conversation

tayloraubry
Copy link
Collaborator

Ported VASP friendly users documentation to main page and cut down text overall

@yandthj yandthj requested review from mcfarljm and yandthj September 21, 2023 15:28
Copy link
Collaborator

@mcfarljm mcfarljm left a comment

Choose a reason for hiding this comment

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

I think the reorganization and simplification is a great improvement.

My main comments are:

  1. Would it be best to remove the VASP sections that currently exist under Swift (https://nrel.github.io/HPC/Documentation/Systems/Swift/running/#running-vasp) and Vermilion (https://nrel.github.io/HPC/Documentation/Systems/Vermilion/running/#running-vasp-on-vermilion), and perhaps replace those with a link to this section, since you have provided examples for all systems here? At a minimum, that reduces duplication and would make it easier to maintain the example scripts moving forward.
  2. I had problems running the example scripts for Vermilion, per my comments. I know that's not the focus of this PR, so I wouldn't want to delay getting these changes incorporated just because of the issues with the vermilion examples. If there aren't quick fixes for the vermilion examples, we should probably create a GH Issue to keep track of getting them updated.

docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
@yandthj
Copy link
Collaborator

yandthj commented Sep 27, 2023

Thanks for the review @mcfarljm . I have a PR in (#501) to remove the VASP sections under Swift and Vermilion pages as you mentioned in your comment.
@tayloraubry If there aren't quick fixes for the vermilion example problems that John pointed out, could you create issues for them or let me know?

@tayloraubry
Copy link
Collaborator Author

@mcfarljm Thanks for the review, I accepted all your suggestions and made several issues surrounding VASP on Vermillion scripts.
@yandthj Let me know if I need to do anything else. (Not sure if I am supposed to close this)

mcfarljm
mcfarljm previously approved these changes Sep 28, 2023
Copy link
Collaborator

@yandthj yandthj left a comment

Choose a reason for hiding this comment

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

Just noted a few spelling errors.

I think it's an improvement to have removed the multiple links/explanations of the benchmark studies repo, but do you think there should be one link to it on this page? I'm not sure if that info is helpful to some users.

docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/vasp.md Outdated Show resolved Hide resolved
@yandthj yandthj merged commit 03857b7 into NREL:gh-pages Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants