Skip to content

PIVA Submission #231

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

Open
20 of 32 tasks
pudeIko opened this issue Jan 4, 2025 · 13 comments
Open
20 of 32 tasks

PIVA Submission #231

pudeIko opened this issue Jan 4, 2025 · 13 comments

Comments

@pudeIko
Copy link

pudeIko commented Jan 4, 2025

Submitting Author: Wojciech Radoslaw Pudelko (@pudeIko)
All current maintainers: Wojciech Radoslaw Pudelko (@pudeIko)
Package Name: PIVA
One-Line Description of Package: Visualization and analysis toolkit for experimental data from Angle-Resolved Photoemission Spectroscopy (ARPES)
Repository Link: https://github.com/pudeIko/piva
Version submitted: v2.3.2
EiC: @coatless
Editor: @crhea93
Reviewer 1: @jsdodge
Reviewer 2: @eigenbrot
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD


Code of Conduct & Commitment to Maintain Package

Description

  • Include a brief paragraph describing what your package does:

PIVA (Photoemission Interface for Visualization and Analysis) is a GUI application designed for the interactive and intuitive exploration of large, image-like datasets. While it accommodates the visualization of any multidimensional data, its features are specifically optimized for researchers conducting Angle-Resolved Photoemission Spectroscopy (ARPES) experiments. In addition to numerous image processing tools and the ability to apply technique-specific corrections, PIVA includes an expanding library of functions and methods for detailed fitting and advanced spectral analysis.

Scope

  • Please indicate which category or categories.
    Check out our package scope page to learn more about our
    scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):

    • Data retrieval
    • Data extraction
    • Data processing/munging
    • Data deposition
    • Data validation and testing
    • Data visualization1
    • Workflow automation
    • Citation management and bibliometrics
    • Scientific software wrappers
    • Database interoperability

Domain Specific

  • Geospatial
  • Education

Community Partnerships

If your package is associated with an
existing community please check below:

  • For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):

Data extraction: Within the ARPES community, it is common for each beamline and lab to use their own file formats and conventions, which means one often need a custom script to get everything into a common format. To handle these discrepancies, PIVA comes with a data_loaders module that converts them into a standardized Dataset object. The current version includes specific Dataloader classes implemented for numerous sources and beamlines around the world.

Data visualization: The package enables efficient and intuitive exploration of large, image-like datasets. It includes specialized interactive viewers designed to handle 2D, 3D, and 4D datasets, depending on the experimental mode or conditions under which they were collected.

  • Who is the target audience and what are scientific applications of this package?

Experimental physicists conducting ARPES measurements. The package provides a comprehensive framework addressing most of the experimenter's needs, including data extraction, inspection, validation, and detailed analysis.

  • Are there other Python packages that accomplish the same thing? If so, how does yours differ?

Regarding software tailored for ARPES, two notable packages are ARPES Python Tools and PyARPES. However, they differ significantly from PIVA.

The visualization module in the former is limited to generating static plots and lacks any interactive features.

The latter is focused on post-processing and detailed analysis of the spectra, and is different in the following respects:

  • interactive exploration and browsing through data is either restricted to 2D data, or conducted inside the Jupyter environment, which highly affects efficiency and makes working with multiple datasets simultaneously difficult.
  • Viewers designed for 4D datasets are not implemented.
  • PIVA's data_loader module contains richer library of data loading scripts for different light sources around the world.

Furthermore, PyARPES has not been maintained for several years.

  • If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:

#223 (@SimonMolinsky)

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

  • does not violate the Terms of Service of any service it interacts with.
  • uses an OSI approved license.
  • contains a README with instructions for installing the development version.
  • includes documentation with examples for all functions.
  • contains a tutorial with examples of its essential functions and uses.
  • has a test suite.
  • has continuous integration setup, such as GitHub Actions CircleCI, and/or others.

Publication Options

JOSS Checks
  • The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
  • The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
  • The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
  • The package is deposited in a long-term repository with the DOI: 10.5281/zenodo.14599024

Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

  • Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Confirm each of the following by checking the box.

  • I have read the author guide.
  • I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.

Please fill out our survey

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

The editor template can be found here.

The review template can be found here.

Footnotes

  1. Please fill out a pre-submission inquiry before submitting a data visualization package.

@coatless
Copy link

coatless commented Jan 21, 2025

Editor in Chief checks

Hi there! Thank you for submitting your package for pyOpenSci
review. Below are the basic checks that your package needs to pass
to begin our review. If some of these are missing, we will ask you
to work on them before the review process begins.

Please check our Python packaging guide for more information on the elements
below.

  • Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
    • The package imports properly into a standard Python environment import package.
  • Fit The package meets criteria for fit and overlap.
  • Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
    • User-facing documentation that overviews how to install and start using the package.
    • Short tutorials that help a user understand how to use the package and what it can do for them.
    • API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
  • Core GitHub repository Files
    • README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
    • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
    • Code of Conduct The package has a CODE_OF_CONDUCT.md file.
    • License The package has an OSI approved license.
      NOTE: We prefer that you have development instructions in your documentation too.
  • Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
  • Automated tests Package has a testing suite and is tested via a Continuous Integration service.
  • Repository The repository link resolves correctly.
  • Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
  • Archive (JOSS only, may be post-review): The repository DOI resolves correctly.
  • Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

  • Initial onboarding survey was filled out
    We appreciate each maintainer of the package filling out this survey individually. 🙌
    Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. 🙌


Editor comments

This is a very well done package, the documentation is nearly perfect with the detailed description of each GUI element and the ability to specify a custom data set. The only issue is the lack of short walk through from data ingestion to modeling using a sample data set.

In addition, it would be highly beneficial to show a fully working custom data loader for a given ARPES file that has a non-standard format. The present example is too sparse.

https://piva.readthedocs.io/en/latest/dataloaders.html#writing-a-custom-dataloader

Please also fix the parameter labels under the API documentation for DataBrowser.add_viewer_to_linked_list()

https://piva.readthedocs.io/en/latest/modules/data_browser.html#data_browser.DataBrowser.add_viewer_to_linked_list

@pudeIko
Copy link
Author

pudeIko commented Jan 23, 2025

Hi @coatless,

Thanks for the great feedback and initial remarks! I've implemented the requested changes:

The only issue is the lack of short walk through from data ingestion to modeling using a sample data set.

I've added a new section to the documentation with an example covering data extraction and basic analysis. I hope this aligns with what you had in mind.

In addition, it would be highly beneficial to show a fully working custom data loader for a given ARPES file that has a non-standard format. The present example is too sparse.
https://piva.readthedocs.io/en/latest/dataloaders.html#writing-a-custom-dataloader

I've prepared a simulated data file and updated the CustomDataloader class so users can test proper configuration and have a more robust template for their code.

Please also fix the parameter labels under the API documentation for DataBrowser.add_viewer_to_linked_list()
https://piva.readthedocs.io/en/latest/modules/data_browser.html#data_browser.DataBrowser.add_viewer_to_linked_list

Done!

I have a technical question. I've committed all changes to the main branch and bumped the version number. Is this the correct approach, or would it be better to keep the changes in a separate branch during the review?

@coatless
Copy link

@pudeIko Thank you for the fast turn around!

That's okay with putting everything into main and tagging a release as this is part of intake. I'll update the starting version number in the ticket to match with the initial EiC intake.

@lwasser lwasser moved this from pre-review-checks to seeking-editor in peer-review-status Jan 23, 2025
@pudeIko
Copy link
Author

pudeIko commented Mar 6, 2025

Hi @coatless,

Hope you're well! I’m just touching base on the review of the software package. I totally understand how things can get busy—just keen to know how it’s going or if there’s anything you need from my side to keep things rolling.

@coatless
Copy link

coatless commented Mar 6, 2025

@pudeIko it's on my end at the moment. We're working on finding a new editor for the submission.

@lwasser lwasser moved this from seeking-editor to under-review in peer-review-status Mar 30, 2025
@coatless
Copy link

@pudeIko Thank you for your patience! We've secured an editor to further move the review along.

We're happy to announce that @crhea93 will be the editor for your submission.

For next step, we'll be working toward getting reviewers assigned. This step is detailed here:

https://www.pyopensci.org/software-peer-review/how-to/author-guide.html#the-review-begins

I'll let @crhea93 introduce himself 🙂

@coatless coatless pinned this issue Mar 30, 2025
@coatless coatless unpinned this issue Mar 30, 2025
@crhea93
Copy link

crhea93 commented Mar 31, 2025

@pudeIko Good morning!
Just to introduce my self briefly -- I am a Ph.D. scientist at the Dragonfly Telescope working on photometric and spectroscopic analysis. I'm very excited to help you through the process of a successful submission!

As @coatless mentioned, the first step is to procure two reviewers -- I will be working on this diligently this week.

Please let me know if you have any questions or need any assistance throughout this process.

@crhea93
Copy link

crhea93 commented Apr 2, 2025

Editor response to review:


Editor comments

👋 Hi @jsdodge and @eigenbrot! Thank you for volunteering to review
for pyOpenSci! I look forward to a successful review!

The first thing you will do is fill out this pre-review survey. Once completed, please move on to the review itself following the review template outlined below.

Please fill out our pre-review survey

Before beginning your review, please fill out our pre-review survey. This helps us improve all aspects of our review and better understand our community. No personal data will be shared from this survey - it will only be used in an aggregated format by our Executive Director to improve our processes and programs.

  • reviewer 1 survey completed.
  • reviewer 2 survey completed.

Please let me know when you have completed your survey so that I can check it off here. You can either let me know in a tagged comment below or in a separate message on slack or via email.

The following resources will help you complete your review:

  1. Here is the reviewers guide. This guide contains all of the steps and information needed to complete your review.
  2. Here is the review template that you will need to fill out and submit
    here as a comment, once your review is complete.

Please get in touch with any questions or concerns! Your review is due: April 22nd, 2025

Reviewers: jsdodge, eigenbrot
Due date: 04/22/2025

@pudeIko
Copy link
Author

pudeIko commented Apr 2, 2025

Hi all! 👋

That's great news, and thank you @crhea93, @jsdodge, and @eigenbrot for joining!

I'm excited to see the ball rolling and look forward to working with you on the review! 🚀

@jsdodge
Copy link

jsdodge commented Apr 2, 2025

Hi @crhea93 , thanks, I've completed the review.

Nice to meet you, @pudeIko, and @eigenbrot! I look forward to working with you on this review.

@crhea93
Copy link

crhea93 commented Apr 2, 2025

@jsdodge @eigenbrot

Fantastic! Thank you two for being so prompt.

The next step is to work your way through the package following the review template. When it is complete, please post your filled in template here as a comment.

@jsdodge
Copy link

jsdodge commented Apr 19, 2025

Package Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor before starting your review).

Documentation

The package includes all the following forms of documentation:

  • A statement of need clearly stating problems the software is designed to solve and its target audience in README.
  • Installation instructions: for the development version of the package and any non-standard dependencies in README.
  • Vignette(s) demonstrating major functionality that runs successfully locally.
  • Function Documentation: for all user-facing functions.
  • Examples for all user-facing functions.
  • Community guidelines including contribution guidelines in the README or CONTRIBUTING.
  • Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

Readme file requirements
The package meets the readme requirements below:

  • Package has a README.md file in the root directory.

The README should include, from top to bottom:

  • The package name
  • Badges for:
    • Continuous integration and test coverage,
    • Docs building (if you have a documentation website),
    • A repostatus.org badge,
    • Python versions supported,
    • Current package version (on PyPI / Conda).

NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)

  • Short description of package goals.
  • Package installation instructions
  • Any additional setup required to use the package (authentication tokens, etc.)
  • Descriptive links to all vignettes. If the package is small, there may only be a need for one vignette which could be placed in the README.md file.
    • Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)
  • Link to your documentation website.
  • If applicable, how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.
  • Citation information

Usability

Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Package structure should follow general community best-practices. In general please consider whether:

  • Package documentation is clear and easy to find and use.
  • The need for the package is clear
  • All functions have documentation and associated examples for use
  • The package is easy to install

Functionality

  • Installation: Installation succeeds as documented.
  • Functionality: Any functional claims of the software been confirmed.
  • Performance: Any performance claims of the software been confirmed.
  • Automated tests:
    • All tests pass on the reviewer's local machine for the package version submitted by the author. Ideally this should be a tagged version making it easy for reviewers to install.
    • Tests cover essential functions of the package and a reasonable range of inputs and conditions.
  • Continuous Integration: Has continuous integration setup (We suggest using Github actions but any CI platform is acceptable for review)
  • Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.
    A few notable highlights to look at:
    • Package supports modern versions of Python and not End of life versions.
    • Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass)

For packages also submitting to JOSS

Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.

The package contains a paper.md matching JOSS's requirements with:

  • A short summary describing the high-level functionality of the software
  • Authors: A list of authors with their affiliations
  • A statement of need clearly stating problems the software is designed to solve and its target audience.
  • References: With DOIs for all those that have one (e.g. papers, datasets, software).

Final approval (post-review)

  • The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing:


Review Comments

@eigenbrot
Copy link

Package Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor before starting your review).

Documentation

The package includes all the following forms of documentation:

  • A statement of need clearly stating problems the software is designed to solve and its target audience in README.
  • Installation instructions: for the development version of the package and any non-standard dependencies in README.
  • Vignette(s) demonstrating major functionality that runs successfully locally.
  • Function Documentation: for all user-facing functions.
  • Examples for all user-facing functions.
  • Community guidelines including contribution guidelines in the README or CONTRIBUTING.
  • Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

Readme file requirements
The package meets the readme requirements below:

  • Package has a README.md file in the root directory.

The README should include, from top to bottom:

  • The package name
  • Badges for:
    • Continuous integration and test coverage,
    • Docs building (if you have a documentation website),
    • A repostatus.org badge,
    • Python versions supported,
    • Current package version (on PyPI / Conda).

NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)

  • Short description of package goals.
  • Package installation instructions
  • Any additional setup required to use the package (authentication tokens, etc.)
  • Descriptive links to all vignettes. If the package is small, there may only be a need for one vignette which could be placed in the README.md file.
    • Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)
  • Link to your documentation website.
  • If applicable, how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.
  • Citation information
    • Currently says "TBD"

Usability

Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Package structure should follow general community best-practices. In general please consider whether:

  • Package documentation is clear and easy to find and use.
  • The need for the package is clear
  • All functions have documentation and associated examples for use
  • The package is easy to install

Functionality

  • Installation: Installation succeeds as documented.
  • Functionality: Any functional claims of the software been confirmed.
  • Performance: Any performance claims of the software been confirmed.
  • Automated tests:
    • All tests pass on the reviewer's local machine for the package version submitted by the author. Ideally this should be a tagged version making it easy for reviewers to install.
    • Tests cover essential functions of the package and a reasonable range of inputs and conditions.
      • See below for a more detailed description
  • Continuous Integration: Has continuous integration setup (We suggest using Github actions but any CI platform is acceptable for review)
  • Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.
    A few notable highlights to look at:
    • Package supports modern versions of Python and not End of life versions.
    • Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass)
      • It appears that the CI linting step is failing, but being ignored

For packages also submitting to JOSS

Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.

The package contains a paper.md matching JOSS's requirements with:

  • A short summary describing the high-level functionality of the software
  • Authors: A list of authors with their affiliations
  • A statement of need clearly stating problems the software is designed to solve and its target audience.
  • References: With DOIs for all those that have one (e.g. papers, datasets, software).

Final approval (post-review)

  • The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing: 7


Review Comments

Summary

The PIVA package is an incredibly well realized toolkit for analyzing multidimensional data, specifically data from ARPES experiments. I don't personally work with ARPES data, but after reading the thorough documentation and playing with PIVA for a few hours I felt I had gained a good understanding of the common data viewing and analysis techniques of that field.

PIVA is undoubtedly a very useful tool for analyzing complex data, and a great addition to the pyOpenSci community. PIVA's representation of, and interaction with, 3D data is so natural and intuitive that I wrote my own toy DataLoadersubclass to view 3D FITS data (a common format in astronomy) and it works great! I love the way binning is represented in the Data Viewer.

The biggest weakness from a user-facing experience is a gap in the documentation regarding the final steps of implementing custom data loaders and GUI plugins. This could be easily remedied with more detailed documentation and examples.

The biggest weakness from a packaging perspective is how the tests are implemented and the test coverage in general.

Specific Comments
Custom Loaders/Plugins
  1. The construction of either a Dataloader subclass or a custom QT widget is generally well described, but how they are imported into PIVA through either DataloaderImporter or PluginImporter is less clear. Examples of these *Importer classes are provided in external files, but I would really like to see a detailed description of the parameters and methods of these classes. They are not mentioned in the otherwise-complete API documentation. A suggestion would be to write abstract bases of these *Importer classes that clearly define the interface.

  2. The fact that a Dataloader subclass must contain a load_data() method is a good indication that Dataloader should probably be an abstract base class.

Test System
  1. Per the documentation, PIVA tests are run by calling the test modules directly, which starts a pytest session. This felt weird to me; I think most people are used to simply running pytest in the project root, which does work for PIVA. Running pytest is the method for testing described in CONTRIBUTING.md.

  2. pytest is not listed in the package requirements table. There is also no "test" pip extra.

  3. Test coverage for the GUI functionality seems high, but the rest of the package could use more tests. In particular, there don't seem to be any tests of the working_procedures module.

  4. Despite the presence of a "tox.ini" file, simply running tox locally fails. (I suspect tox is only used for CI builds, so maybe this doesn't matter)

Use of Older Frameworks

There are few places in the code where older methods and frameworks could be replaced with more modern alternatives that would improve the maintainability and robustness of the package. In particular:

  1. The Dataset class inherits from python's Namespace class, which allows for properties to be accessing with a nice ds.property syntax. I would highly recommend moving to using either python dataclasses or pydantic BaseModels, both of which are specifically designed for this type of interaction. Pydantic's BaseModel also offers a lot of useful type-validation functionality that may be particularly useful because the internals of the Dataset are tightly constrained to how that class is used by other code.

  2. In a few places (e.g., Notebooks created by the "touch" button in the Data Viewer) file paths are concatenated with a + operator. At the very least I would recommend using os.path.join, or (even better) pathlib.Path objects.

Documentation

Overall the documentation is extremely good. My comments are minor:

  1. PIVA's pypi page does not contain a "Documentation" link to the readthedocs site. This is a shame because the documentation is so good!

  2. I think the "What is piva" section would be more impactful if the multiple strengths/features of piva were given their own subheadings.

  3. The "Implemented Dataloaders" table is great, and would be even more great if the individual data loaders were links to the respective class in the API documentation.

  4. On the "Data Ingestion and Analysis" page it would be very useful to have an example dataset (the same one used in the example code) so a user can follow along directly. I was eventually able to run the notebook with one of the "test/data" datasets; perhaps elevating one or more of these datasets to an "examples" folder would make their utility more obvious.

Misc
  • Data Viewer line plots show nothing if NaN values are present. The images still render correctly.
  • astropy is listed as a dependency, but I can't find its usage anywhere
  • Related, the use of astropy.units might be helpful. It's also possible the entire constants module could be replaced with astropy.constants.
  • When Saving data to a pickle (via the "save" button in the Data Viewer) it would be nice to be able to specify the save directory.
  • I found db as the script name to be a little confusing. I kept expecting it to be piva.
  • I was expecting the "touch" and "start JL session" buttons to populate a notebook with correct paths for the dataset loaded into the Data Viewer. Instead it looks like they just copied a generic template to the given directory.
  • It looks like ruff errors are being ignored in CI
  • In tiled window manager, content in windows gets truncated if the window is small enough
  • Any opened Jupyter sessions (created with the "start JL session" button) persist after closing all Piva windows.
  • Installation was painless with multiple methods, even those not described in the documentation. FWIW, PIVA appears to work correctly (and the tests pass) for all python versions between 3.10 and 3.13.
  • When clicking the "open in PIT" button the resulting PIT window displays a terminal with the following error in python 3.11 (but not 3.10):
Cell In[1], line 1
----> 1 get_ipython().run_line_magic('pylab', 'qt')

File ~/micromamba/envs/piva11/lib/python3.11/site-packages/IPython/core/interactiveshell.py:2481, in InteractiveShell.run_line_magic(self, magic_name, line, _stack_depth)
   2479     kwargs['local_ns'] = self.get_local_scope(stack_depth)
   2480 with self.builtin_trap:
-> 2481     result = fn(*args, **kwargs)
   2483 # The code below prevents the output from being displayed
   2484 # when using magics with decorator @output_can_be_silenced
   2485 # when the last Python token in the expression is a ';'.
   2486 if getattr(fn, magic.MAGIC_OUTPUT_CAN_BE_SILENCED, False):

File ~/micromamba/envs/piva11/lib/python3.11/site-packages/IPython/core/magics/pylab.py:159, in PylabMagics.pylab(self, line)
    155 else:
    156     # invert no-import flag
    157     import_all = not args.no_import_all
--> 159 gui, backend, clobbered = self.shell.enable_pylab(args.gui, import_all=import_all)
    160 self._show_matplotlib_backend(args.gui, backend)
    161 print(
    162     "%pylab is deprecated, use %matplotlib inline and import the required libraries."
    163 )

File ~/micromamba/envs/piva11/lib/python3.11/site-packages/ipykernel/inprocess/ipkernel.py:200, in InProcessInteractiveShell.enable_pylab(self, gui, import_all, welcome_message)
    198 if not gui:
    199     gui = self.kernel.gui
--> 200 return super().enable_pylab(gui, import_all, welcome_message)

TypeError: InteractiveShell.enable_pylab() takes from 1 to 3 positional arguments but 4 were given

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: under-review
Development

No branches or pull requests

5 participants