plenoptic-org / plenoptic

Visualize/test models for visual representation by synthesizing images.
https://plenoptic.readthedocs.io/en/latest/
MIT License
61 stars 9 forks source link

updates install instructions #294

Closed billbrod closed 2 months ago

billbrod commented 2 months ago

Following @NickleDave's point in #238 , tells people to run pip install -e .[dev] as the default for local install, since they'll probably want the tests.

Also wraps the install target in quotes when including optional dependencies, which is necessary for zsh.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

billbrod commented 2 months ago

I agree with your points, went ahead and made those changes. Let me know what you think!

For now, I moved the jupyter content to a separate file; I'm going to do a bit of restructure of the docs soon, so exactly how things are arranged will change, but I agree it's separate.