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

feat: make jupyter a dev dependency #2755

Closed

Conversation

deepeshaburse
Copy link
Contributor

Description

This PR helps to make jupyter a dev depenency. To do this:

  1. jupyter has been removed from requirements.txt.
  2. 'jupyter' has been shifted to "dev" from "install_requires" in setup.py.

Fixes #2457

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all
  • The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deepeshaburse you will have to debug and fix the failing tests in order for us to review this PR. You can click on the details button of any of the tests and it will redirect you to the logs. The tests are failing with the error -

Traceback (most recent call last):
  File "/Users/runner/work/PyBaMM/PyBaMM/run-tests.py", line 10, in <module>
    import pybamm
  File "/Users/runner/work/PyBaMM/PyBaMM/pybamm/__init__.py", line 166, in <module>
    from .parameters.parameter_sets import parameter_sets
  File "/Users/runner/work/PyBaMM/PyBaMM/pybamm/parameters/parameter_sets.py", line 2, in <module>
    import importlib_metadata
ModuleNotFoundError: No module named 'importlib_metadata'
ERROR: InvocationError for command /Users/runner/work/PyBaMM/PyBaMM/.tox/mac-windows-unit/bin/python run-tests.py --unit (exited with code 1)

I am guessing that jupyter was installing importlib_metadata for us, but we now might have to explicitly list it as one of our dependencies.

@Saransh-cpp
Copy link
Member

@deepeshaburse any progress with this?

@Saransh-cpp
Copy link
Member

Being worked upon in #2846

@Saransh-cpp Saransh-cpp closed this Apr 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make jupyter a dev-only dependency
2 participants