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

Document species covered by each dataset #132

Open
gabrielasd opened this issue Dec 6, 2024 · 1 comment
Open

Document species covered by each dataset #132

gabrielasd opened this issue Dec 6, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@gabrielasd
Copy link
Collaborator

gabrielasd commented Dec 6, 2024

As pointed out on issue #125, we should provide information on what species are available with each dataset.

... how we can easily express which atoms/ions are covered by which datasets. It would be good to have a very short description of which species are covered in each dataset, especially since only the hci dataset is actively changing.

@gabrielasd gabrielasd added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Dec 6, 2024
@PaulWAyers
Copy link
Member

@msricher pointed out that one can assess which species are present using

For the load function, you can use ... for any of the elem, charge, mult, nexc values.

We should probably add some usage of this in one of our example notebooks, so that people can understand this usage too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants