Make parameters importable from a directory having "pybamm" in its name

[Saransh-cpp]

Description

Check for pybamm/input/parameters instead of pybamm while trying to import parameters from the base package.

Fixes #1918

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: $ flake8
• All tests pass: $ python run-tests.py --unit
• The documentation builds: $ cd docs and then $ make clean; make html

You can run all three 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

[codecov]

Codecov Report

Merging #1919 (eab470b) into develop (1c209f2) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop    #1919   +/-   ##
========================================
  Coverage    99.32%   99.32%           
========================================
  Files          346      346           
  Lines        19002    19002           
========================================
  Hits         18874    18874           
  Misses         128      128           

Impacted Files	Coverage Δ
pybamm/util.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c209f2...eab470b. Read the comment docs.

[priyanshuone6]

Could you add some tests

[Saransh-cpp]

Could you add some tests

For some reason, the tests for the modified line don't work. I tried doing -

        pybamm.set_logging_level("DEBUG")
    
        import subprocess

        # create a new lithium_ion folder in the root PyBaMM directory
        subprocess.run(["pybamm_edit_parameter", "lithium_ion"])
       
        # path for a function in the created directory -> x/y/z/PyBaMM/lithium_ion/negative_electrode/ ....
        test_path = os.path.join(
            os.getcwd(),
            "lithium_ion",
            "negative_electrodes",
            "graphite_Chen2020",
            "graphite_LGM50_electrolyte_exchange_current_density_Chen2020.py",
        )

        # check if the lithium_ion directory is present in PyBaMM -> It is
        print(os.listdir(os.getcwd()))

        # load the function
        func = pybamm.load_function(test_path)
        self.assertEqual(
            func,
lithium_ion.negative_electrodes.graphite_Chen2020.graphite_LGM50_electrolyte_exchange_current_density_Chen2020.graphite_LGM50_electrolyte_exchange_current_density_Chen2020,  # noqa
      )

This shows me -

2022-01-29 17:36:39,496 - [DEBUG] util.load_function(312): Importing function 'graphite_LGM50_electrolyte_exchange_current_density_Chen2020' from file 'C:\Users\Saransh\Saransh_softwares\OpenSource\Python\PyBaMM\lithium_ion\negative_electrodes\graphite_Chen2020\graphite_LGM50_electrolyte_exchange_current_density_Chen2020' via path 'lithium_ion.negative_electrodes.graphite_Chen2020.graphite_LGM50_electrolyte_exchange_current_density_Chen2020'

ModuleNotFoundError: No module named 'lithium_ion'

Importing parameters from anywhere works completely fine outside of the testing suite.

Apparently, importing parameters from anywhere else than pybamm/input/parameters/ is not tested in PyBaMM. I couldn't really figure out why is it not working in tests but is working when used elsewhere.

[valentinsulzer]

is "\\" a single character?

[Saransh-cpp]

Yes

[valentinsulzer]

Apparently, importing parameters from anywhere else than pybamm/input/parameters/ is not tested in PyBaMM. I couldn't really figure out why is it not working in tests but is working when used elsewhere.

Yeah this is strange, I get this error locally as well

[priyanshuone6]

Could you merge develop and move this to the unreleased section

[valentinsulzer]

Did you want to add a test for this? Or shall I merge?

[Saransh-cpp]

Did you want to add a test for this? Or shall I merge?

I found the issue with the failing tests -

• The tests pass when run using python run-tests.py --unit as the .../..../PyBaMM directory is in sys.path
• The tests fail when test_utils.py is run individually, as now ..../..../PyBaMM/tests/unit is in sys.path and not .../..../PyBaMM

[valentinsulzer]

Thanks!