PyEED / pyeed

🧬 Toolkit to create, annotate, and analyze specialized sequence databases
https://pyeed.github.io/pyeed/
MIT License
3 stars 5 forks source link

Naming of the GitHub/PyEED/... tree #14

Closed itbjpl closed 7 months ago

itbjpl commented 1 year ago

The naming of the structure of our PyEED repository is confusing. The path https://github.com/PyEED/pyeed/tree/main/pyEED/core contains three times "pyeed". At the highest level (https://github.com/PyEED), it is clear that "PyEED" means the PyEED project. But the meaning of pyeed on the other levels in not self-explaining. Any suggestions for an unequivocal naming of the different levels?

We might also try to visualize the different layers (Workflow - Utility fuctions - data model) to explain the PyEED concept. PyEED structure.pdf

haeussma commented 1 year ago

We could change the name of the pyeed repo, which contains the library, to pyeed-lib

torogi94 commented 1 year ago

For now, I think going with pyeed-lib is the right call to avoid confusion.

Still, in the future we could think about the PyEED (brand) name some more and maybe search for one less ambiguous – either for the institution, the library, or both, while still keeping PyEED as the term for the concept (similarly to sdRDM).