fix tests, update installation instructions, add case study

[jgraeb]

• updated the tests to run in conda environment
• updated installation instructions in readme and installation page on website
• added package delivery case study

[codecov-commenter]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

[jgraeb]

The MacOS test with conda (python 3.10) succeeded for the second to last commit, but then I just removed the badge svg file and the htmlcov directory and it is broken again (these changes shouldn't have affected the workflow). @slivingston do you have any ideas why this is so unstable?

[slivingston]

@slivingston do you have any ideas why this is so unstable?

This error seems to be something from PDM while fetching packages. In other words, it may be an intermittent loss of connection to the server hosting package files. I would expect that PDM has some retry logic, so this kind of error should be very rare, unless the package server is completely offline. I just restarted the job to try again. If it fails again, I think the cause is something else and will need to investigate.

[slivingston]

The job succeeded upon retry, so I think the remaining task is for me to check whether I need to enable Codecov with the tulip-control organization.

[slivingston]

Which Python package includes this extension? In general, can you also write instructions for building the docs?

For this, I recommend to move the docs dependencies from docs/requirements.txt into pyproject.toml as optional dependencies following the example in the PDM docs. Then the building the docs instructions can be as simple as

pdm install -G docs
mkdocs build

[slivingston]

@jgraeb I still encounter errors when trying to install it. I will investigate more in the next few days, but for this PR, if the code is working for you locally, I think that you can address my comments and then squash-merge this into the main branch.

I suggest squash-merge so that all of the commits are combined into a single commit, because the sequence of commits of this PR seems to have duplicates and other changes that are not likely to be useful to look back on later (compared with the PR as a whole).