It also allows CACE to be build as a Python package and installs the two commands cace and cace-gui.
Additionally, the README has been formatted in Markdown, and the documentation has been moved to docs/.
Things to be done after this PR:
Apply black to the codebase and add a formatting check to the CI
Push the Python package for CACE to PyPI
Host the docs somewhere, and improve the docs
Probably much more ...
I think this PR is ready as is (if it works for you). I would like to perform the formatting of the codebase in a separate PR as I think it introduces less noise in the git history - easier to look changes up.
This PR restructures the project to be compatible with the recommended file structure for a Python project. https://docs.python-guide.org/writing/structure/
It also allows CACE to be build as a Python package and installs the two commands
caceandcace-gui. Additionally, the README has been formatted in Markdown, and the documentation has been moved todocs/.Things to be done after this PR:
I think this PR is ready as is (if it works for you). I would like to perform the formatting of the codebase in a separate PR as I think it introduces less noise in the git history - easier to look changes up.