Coding best practices

[Zethson]

This is a totally random list of things that are currently not best practice in this repository that we eventually want to resolve with #27 by fixing #17 .

1. The package has too many dependencies and some of them are difficult to install. Ideally we don't depend on users to install packages in a specific order nor having to use Conda

To resolve this we should double check every dependency. Do we really need it and can we get rid of it? Why are there installation issues for some of them on different platforms? Is there a way to get rid of all Conda dependencies? If not, can we create a conda package for sparcs?

2. The package should be trivially installable.

Get it on PyPI and Conda

3. Separate CLI and library. This brings a lot of complexity and weird code structure. Don't do it.

We create sparcs and sparcs-cli. Eventually both of them are on PyPI and Conda. The CLI package has sparcs and optionally click/whatever as dependencies. This helps us resolve weird code structure

4. Doc structure is off.

There should be a single docs folder with potentially a source folder. We'll just use what the scverse templates provides us with.

5. Code formatting and docstyles are off.

We'll use the Ruff + pre-commit setup of the scverse template. We'll use Google docstring style and configure Ruff to check it.

6. setup.py is legacy

Adopt the pyproject.toml setup from the template. The files defined in the MANIFEST should be picked up and shipped automatically. However, larger files should potentially be downloaded lazily on request.

7. The README is overwhelming.

Keep it minimal and remove the complex installation instructions. We'll just make it so easy so that this won't be necessary anymore Ha!

8. No unit tests.

We should have unit tests so that at least every public function is tested. An integration test for the whole pipeline would also be good.

[sophiamaedler]

This is the priority order in which I would try and tackle these:

High Priority

• update package to use pyproject.toml instead of setup.py Create pyproject.toml and LICENSE #52
• streamline dependencies Review requirements.txt #53
• adapt doc structure to fit in with scverse standards
• reformat code with linting + ensure docstrings are in correct format
• provide installation via pip and/or conda

Medium Priority

• move datasets and model checkpoints to zenodo and download on demand Upload existing datasets to Zenodo and move docs #51
• move command line tools to separate package
• update documentation to reflect new sparcsspatial structure
• add missing docstrings

Lowest Priority

• Unit tests
• full pipeline test testing: implement full pipeline test with an example datasets #9

[sophiamaedler]

documentation was automated and moved to correct location in #98