Documentation and CLI for backend selection #112
Merged
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
Jnelen
reviewed
Mar 7, 2024
|
I quickly skimmed through everything. Great clean-ups and changes! |
|
Thank you so much for having a look @Jnelen, much appreciated!
Yes, 100%. I wanted to add |
Always glad to be of help! Don't hesitate to reach out to me for any future PRs where you think I could lend a hand! |
Jnelen
reviewed
Mar 7, 2024
|
Thanks for the review/help @Jnelen! |
Glad to be of help! |
RMeli
added a commit
that referenced
this pull request
Apr 5, 2024
* add details on NotImplementedError exceptions * changelog * remove versioneer * changelog * fix warning * fix tests with pytest 8 * update changelog * update ci * add setuptools for python 12 * setuptools in ci * use miniconda, conda is missing from macos-14 * miniforge * fixes * mamba * bump min python version * update changelog * Update build system to flit_core * Add entry to changelog * Update CHANGELOG.md * Delete .gitattributes * Delete .lgtm.yml * Update CHANGELOG.md * Add functionality to select backend (#107) * Documentation and CLI for backend selection (#112) * Add rustworkx backend (#111) * Update graph.py to support set_backend function I also made a fuction to see the available backends and get the current backend * Apply private _available_backends suggestions from code review This commit contains the suggested changes regarding making the available_backends variable private, and refactoring the get_available_backends method to available_backends Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Print warning when backend is already set + make sure we use _available_backends everywhere where possible * remove reliance on environment variables * make _validate_backend function print warning when a certain backend isn't installed * Use precommit hooks add __all__ back refactor _alias_backendDict to _alias_to_backend * Update ValueError message Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Don't return the backend when setting it Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Add dummy function to make mypy happy remove __all__ assignment * fist play with rustworkx backend * add documentation for backend selection * add cli backend selection * cleanup * changelog * apply @Jnelen suggestion and add warning filter * make molecule test also more robust * add rx to ci * add rustworkx to all backends tests * add back graphtool * add rx to test all backends and add verbose mode * Update test_molecule.py --------- Co-authored-by: jnelen <jnelen@ucam.edu> Co-authored-by: Jochem Nelen <78348388+Jnelen@users.noreply.github.com> * Update .readthedocs.yml (#114) * Update .readthedocs.yml * rm duplicate key * prepare release 0.7.0 --------- Co-authored-by: Thomas Kluyver <takowl@gmail.com> Co-authored-by: Jochem Nelen <78348388+Jnelen@users.noreply.github.com> Co-authored-by: jnelen <jnelen@ucam.edu>
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.
Description
Close #108 and close #109.
This PR adds documentation related to #107:
READMEThis PR adds the
-g/--graph-backendto manually select a backend from CLI.Additionally, the following cleanup is done:
importlib.utilsto check if a package is available, without importing itChecklist