📝 DOCS: Updates for compatibility with AiiDA v2.5.1 #469
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These minor changes fix issues and deprecation warnings that arose when going through the tutorial with the latest AiiDA v2.5.1. The modifications are mainly: - Update the `verdi code setup` to `verdi code create` commands - Update the SSSP version from 1.1 to 1.3 to reflect the change of default in `aiida-pseudo` - Prepend `core` in the `DataFactory` calls where applicable, as well as `query.queryhelp` -> `query.as_dict()` in the `querying` notebook One could also update the outputs, for instance, to reflect the change from `Info` to `Report` for the `verdi process` commands, as well as adding the additional information on caching which is now shown to avoid confusion, though it's not really necessary for being able to work through the material. I understand that this page was initially intended for the AiiDA courses, so it's good to have a frozen version for each edition of the course. Though, as we'd like to eventually integrate this material into the main documentation (see issue #XXXX), I think it's good to have it updated now. Lastly, a few deprecation warnings remain, for example: ```shell - aiida/cmdline/groups/dynamic.py:145: AiidaDeprecationWarning: Relying on `_get_cli_options` is deprecated. The options should be defined through a `pydantic.BaseModel` that should be assigned to the `Config` class attribute. (this will be removed in v3) - aiida/orm/nodes/data/code/legacy.py:42: AiidaDeprecationWarning: The `Code` class is deprecated. To create an instance, use the `aiida.orm.nodes.data.code.installed.InstalledCode` or `aiida.orm.nodes.data.code.portable.PortableCode` for a "remote" or "local" code, respectively. If you are using this class to compare type, e.g. in `isinstance`, use `aiida.orm.nodes.data.code.abstract.AbstractCode`. (this will be removed in v3) - aiida/orm/nodes/data/code/legacy.py:172: AiidaDeprecationWarning: `Code.get_description` method is deprecated, use the `description` property instead. (this will be removed in v3) ``` however, I think these have to be adressed in the `src`.
GeigerJ2
requested review from
mbercx,
giovannipizzi,
khsrali and
edan-bainglass
|
Could you rebase? |
Best I can do is merge commit 😅 Should I squash and merge? |
agoscinski
approved these changes
Sep 11, 2024
There was a problem hiding this comment.
Just wanted to see it in the RTD docs preview, and see if the CI passes. Looks fine for me. The verdi commands seem also still valid for 2.6. You can squash and merge!
Wow the commit message is insanely long. Maybe you want to shorten it a bit, but your call.
Commit essay has to be longer than the code changes :D I shortened it, just listing the actual changes, not my other rambling. |
GeigerJ2
removed request for
giovannipizzi,
mbercx,
khsrali and
edan-bainglass
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These minor changes fix issues and deprecation warnings that arose when going through the tutorial with the latest AiiDA v2.5.1. The modifications are mainly:
verdi code setuptoverdi code createcommandsaiida-pseudocorein theDataFactorycalls where applicable, as well asquery.queryhelp->query.as_dict()in thequeryingnotebookOne could also update the outputs, for instance, to reflect the change from
InfotoReportfor theverdi processcommands, as well as adding the additional information on caching which is now shown to avoid confusion, though it's not really necessary for being able to work through the material.I understand that this page was initially intended for the AiiDA courses, so it's good to have a frozen version for each edition of the course. Though, as we'd like to eventually integrate this material into the main documentation (see issue
aiidateam/aiida-core#6287), I think it's good to have it updated now.
Lastly, a few deprecation warnings remain, for example:
however, I think these have to be adressed in the
src.