PyPI package necessities

[asemposki]

Here is the list of PyPI package needs that should be addressed before publication of this package. I have assigned both @sudhanvalalit and @Ub3rJosh so that we all double check everything before this work is completed.

• Organised source code into modules
• Universal paths for the installation to be found
• Full API/docstrings for each function
• Documentation page through github-pages or Read the Docs (I vote GitHub pages via mkdocs theme because it's easy to convert my SAMBA page to the SLM page), aka a GitHub workflow for this (I'm experienced in these now)
• Tutorial notebooks for new users
• Zenodo citation or paper citation (I vote paper citation, for perhaps obvious reasons as a physicist who depends on paper citations, not software citations)
• PyPI script in the form of pypiproject.toml or requirements.txt with setup.py file (I'll check how we did this for Taweret and copy it all exactly except for C++ handles because we don't need that bs)
• Unit tests (pytest tests) for the code to run each time a merge is made or push or release
• Logo generation for the package

[asemposki]

How are our docstrings looking for the SLM algorithm part?