-
Notifications
You must be signed in to change notification settings - Fork 618
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
Added about() functionality for qutip_qip #1870
Open
claretgrace0801
wants to merge
11
commits into
qutip:master
Choose a base branch
from
claretgrace0801:master
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
6a60788
added about functionality for qutip_qip
claretgrace0801 14b7fe9
added qutip-qip about functionality
claretgrace0801 db6f7d2
about function qutip_qip
claretgrace0801 3fec1f8
about function qutip_qip
claretgrace0801 10bfa52
other qutip libraries will not have to change anything in the qutip a…
claretgrace0801 40cf5e9
Merge branch 'qutip:master' into master
claretgrace0801 1df8257
Merge branch 'qutip:master' into master
claretgrace0801 eb534d2
about entrypoints - family packages
claretgrace0801 ecf8af6
about - (family packages) added changelog
claretgrace0801 8bb32a5
about - updated docstring
claretgrace0801 f8ee7b5
about - updated docstring
claretgrace0801 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Added about() functionality for qutip_qip |
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
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -11,12 +11,14 @@ | |||||||
import inspect | ||||||||
from qutip.utilities import _blas_info, available_cpu_count | ||||||||
import qutip.settings | ||||||||
import pkg_resources | ||||||||
|
||||||||
|
||||||||
def about(): | ||||||||
""" | ||||||||
About box for QuTiP. Gives version numbers for QuTiP, NumPy, SciPy, Cython, | ||||||||
and MatPlotLib. | ||||||||
Also provides information about installed family packages like qutip-qip. | ||||||||
""" | ||||||||
print("") | ||||||||
print("QuTiP: Quantum Toolbox in Python") | ||||||||
|
@@ -61,6 +63,19 @@ def about(): | |||||||
qutip_install_path = os.path.dirname(inspect.getsourcefile(qutip)) | ||||||||
print("Installation path: %s" % qutip_install_path) | ||||||||
|
||||||||
# family packages | ||||||||
entrypoints = pkg_resources.iter_entry_points('qutip.about') | ||||||||
for ep in entrypoints: | ||||||||
about_func = ep.load() | ||||||||
try: | ||||||||
title, lines = about_func() | ||||||||
except Exception as exc: | ||||||||
title, lines = ep.name, [str(exc)] | ||||||||
print() | ||||||||
print(title) | ||||||||
for line in lines: | ||||||||
print(line) | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Add an empty line incase there are other family packages |
||||||||
|
||||||||
# citation | ||||||||
longbar = "=" * 80 | ||||||||
cite_msg = "For your convenience a bibtex reference can be easily" | ||||||||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is better to use importlib rather than
pkg_resources
as stated in their documentation. The latter might be deprecated in the future.