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

Provide better examples and documentation for JSON and YAML input #257

Open
sobolevnrm opened this issue Nov 24, 2022 · 5 comments
Open

Comments

@sobolevnrm
Copy link
Member

The JSON documentation exists, it just isn't very good. This section of the manual provides an overview of the keys and values expected in JSON- or YAML-format input. Sorry we don't have more direct examples -- I'll create an issue to generate these in the future.

Originally posted by @sobolevnrm in #256 (comment)

@sobolevnrm
Copy link
Member Author

These examples should include specific invocation instructions per #256 (comment).

@supernova4869
Copy link

Have you ever added examples of using json or yaml with APBS to the manual?

@sobolevnrm
Copy link
Member Author

No. However, we welcome community help to improve our documentation. Thank you.

@supernova4869
Copy link

supernova4869 commented Mar 18, 2023

Can apbs program directly read yaml file as PBSA calculation input, instead of old plain text format? If so, what is the particular command?

@sobolevnrm
Copy link
Member Author

This is high on my to-do list but I am not sure when I'll be able to get started.

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

No branches or pull requests

2 participants