Jammy2211 / PyAutoGalaxy

PyAutoGalaxy: Open-Source Multiwavelength Galaxy Structure & Morphology
https://pyautogalaxy.readthedocs.io/
MIT License
28 stars 13 forks source link

If Workspace is that important, why is it not in this repo? #63

Closed pllim closed 1 year ago

pllim commented 2 years ago

From https://pyautogalaxy.readthedocs.io/en/latest/general/workspace.html and throughout the documentation, it seems like autogalaxy workspace is an integral part of this package (not merely optional supplementary material?). If so, why not include it as part of this package? (Can always exclude from the manifest if you do not want it in the sdist tarball.)

https://github.com/astropy/astropy.github.com/pull/491#issuecomment-1215349065

pllim commented 2 years ago

Related: If Workspace notebooks are indeed essential, consider adding Jupyter notebook installation instructions to the "conda" section of installation pages.

Or if you want to lock things down more, provide a conda environment YAML file.

Jammy2211 commented 1 year ago

The primary reason is that the workspace contains notebooks and .fits datasets, which in the past have caused a lot of problems with bulking-out the repo history. By keeping them on a separate repo we avoid the source code history being noisy or (as was the case a long time ago) broken.

I also didn't find it much help having the workspace buried in the site-packages of an install.