draeger-lab / refinegems

refineGEMs is a python package inteded to help with the curation of genome-scale metabolic models (GEMS).
https://refinegems.readthedocs.io/en/latest/
MIT License
10 stars 0 forks source link

Enhance availability of refineGEMs #85

Open GwennyGit opened 1 year ago

GwennyGit commented 1 year ago

To enhance the availability of the whole refineGEMs package I would suggest the following options:

GwennyGit commented 11 months ago

For task 1, another idea would be to split the tool into different entry points. One for model investigation, one for model refinement and one for model curation.

How to achieve?

'Main' module/Command line name Relevant modules Description
data databases Handles database input/output & initialisation
investigate comparison, growth, investigate, gapfill.gap_analysis Handles model comparison, growth simulation & other types of model investigation
refine biomass, charges, modelseed, pathways, polish, sboann Handles all possible refinement techniques implemented in refineGEMs
curate curate, gapfill.gapfill_model Handles the curation implementations of refineGEMs
GwennyGit commented 11 months ago

The setup.py should be replaced by a setup.cfg as the setup.py file is legacy and might get deprecated. A possible setup.cfg, already including the setup for the possible entry points, was generated and uploaded to the branch structure_update.

As with refineGEMs 1.4.0 the pyproject.toml file was adjusted so that the complete install is only handled by the pyproject.toml. This deprecates the setup.cfg which is now removed with the commit Removed no longer needed setup.cfg. The already existing entry points were moved as comments to the pyproject.toml file with the commit Added entry points as comments to pyproject.toml and need to be tested and adjusted before use.

GwennyGit commented 11 months ago

All commits from the last comment to this comment are the result of my attempt to rebase these commits from dev to another branch. However, this did not work and, thus, I will cherry-pick the according commits to the other branch. This will likely add the same commits again in this issue after this comment.

cb-Hades commented 6 months ago

Currently, refineGEMs works for python 3.10 and 3.9. Release 2.0.0 should work under 3.10 and 3.11