paramm-team / pybamm-param

Parameter optimisation for PyBaMM.
BSD 3-Clause "New" or "Revised" License
37 stars 8 forks source link

Development install of `pbparam`, formalising requirements, and changing testing to nox. #48

Closed PipGrylls closed 1 year ago

PipGrylls commented 1 year ago

Following a debug of a problem there are some structural changes and decisions that need to be made.

The current documentation uses pip to install pybamm-param from github and leaves the rest of the requirements to the user to figure out. (virtualenv is used which is excellent)

However, for development and testing we really should load pbparam via pip install -e pbparam.

However, however, there are other package managers we could be using.

pip - installed with python, standard, bit dated, PyPi

poetry - much more modern, really nice docs (https://python-poetry.org/docs/dependency-specification/#path-dependencies), not as widely used.

conda - widely used, strong dependancy resolution, often painfully slow, bloated

My recommendation would be to use pip or poetry.

To close this issue:

brosaplanella commented 1 year ago

PyBaMM uses pip, so I would choose it too for pbparam.

PipGrylls commented 1 year ago

Updating the title to better reflect the scope of the issue.

PipGrylls commented 1 year ago

Updating issues:

I’m adding a few things here, and changing some things to make more sense.

PipGrylls commented 1 year ago

Updating issues:

Tox is fully deprecated by nox here, the development install is in the docs and the workflow runs

https://github.com/paramm-team/pybamm-param/commit/8b250b9a40c6e1b115aef07fe2d1fa923f076dc4

PipGrylls commented 1 year ago

@brosaplanella Please take a look at the PR this is done