search

desy-ml / cheetah

Fast and differentiable particle accelerator optics simulation for reinforcement learning and optimisation applications.
https://cheetah-accelerator.readthedocs.io
GNU General Public License v3.0
30 stars 13 forks source link

Deprecated Legacy Editable Installation #245

Open Hespe opened 2 weeks ago

Hespe commented 2 weeks ago

Starting from pip version 25.0, the current package defintion of cheetah will no longer be supported for editable installations. An up-to-date version currently prints the following warning:

Legacy editable install of cheetah-accelerator is deprecated. pip 25.0 will enforce this behaviour change. A possible replacement is to add a pyproject.toml or enable --use-pep517, and use setuptools >= 64. If the resulting installation is not behaving as expected, try using --config-settings editable_mode=compat. Please consult the setuptools documentation for more information. Discussion can be found at https://github.com/pypa/pip/issues/11457

See also the mentioned setuptools documentation on editable installs.

Hespe commented 2 weeks ago

From the discussion in the linked pip issue, it seems like the intended solution is to migrate to a pyproject.toml based package structure, which will continue to support editable installations.