Development Roadmap and Future of ModOpt.

[paquiteau]

I reckon that I have started multiple PRs, moving forward here is a proposition for the integration of this work.

I would recommend we use a squash+rebase strategie, to minimize the effect on the main trunk. To smooth things up here is what I propose:

• 1. merge the CI-update (Ci update #268) into develop
• 1.5 fix the test due to astropy upgrade ([BUG] Changes to astropy.convolution.Gaussian2DKernel break tests #272)
• 2. pull develop and merge the test refactorisation PR (Test rewrite #266)
  (- [ ] 3. pull develop and merge the PnP PR (Add support for Plug'n Play algorithm #265))
• 3. merge the Example2Test PR (Use example scripts as tests. #277)
• 4. pull develop and merge the ADMM PR (Add support for ADMM #263)
• 5. Run Black once, and update the test to use --black check. There should also be modification of isort ¹

In a later future (e.g. start of Q2 2023), taking the opportunity of a coding sprint:
7. Write test for the new algorithms. This might also be the opportunity to revisite the significance of all optimisation algorithm, to solve a less dummy problem (for instance a LASSO regularised least square)
8. Move the configuration to pyproject.toml , and maybe use a src layout ², -> this seems to be the new standard ³⁴
9. Release a new ModOpt version (2.0 ? )
10. Write new a paper about it, add it to zenodo⁵ to get a DOI for the package.

Footnotes

1. https://pycqa.github.io/isort/docs/configuration/black_compatibility.html ↩

2. https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/ ↩

3. https://packaging.python.org/en/latest/tutorials/packaging-projects/ ↩

4. https://github.com/pypa/sampleproject ↩

5. https://zenodo.org/ ↩

[sfarrens]

Sounds like a good plan to me @paquiteau!

Some other points to consider:

• Many Python projects are moving away from using setup.py and setup.cfg to exclusively using a pyproject.toml file, perhaps we can consider doing the same for ModOpt. Black can be configured directly in pyproject.toml but requires additional tools for setup.cfg.
• Should we open an issue to discuss the best way to configure Black for ModOpt?

[paquiteau]

I mention the move to pyproject.toml in point 8 ;) Setuping the pyproject.toml should not be a big deal (I am getting pretty good at it and relies already on it for several of my projects, including pysap-fmri). this change of config file could happen simultaneously with the black formatting IMO.

[sfarrens]

Sorry I missed that, but since this is tied to the configuration of Black I think point 8 is linked to point 5 and should probably be done in conjunction.