Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename usage examples #67

Merged
merged 10 commits into from
Oct 27, 2021
Merged

Rename usage examples #67

merged 10 commits into from
Oct 27, 2021

Conversation

bwohlberg
Copy link
Collaborator

Rename example scripts. Also partially addresses #47.

See lanl/scico-data#1, which should be merged just prior to merging this PR.

@bwohlberg bwohlberg added documentation Improvements or additions to documentation examples Pertaining to SCICO examples labels Oct 26, 2021
Copy link
Contributor

@Michael-T-McCann Michael-T-McCann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I didn't go as far as rendering the docs, but I trust that it looks fine.

examples/admm_tv_deconvolution
examples/admm_tv_circ_deconvolution
examples/pgm_ppp_bm3d_deconvolution
examples/deconv_circ_tv_admm
examples/deconv_microscopy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deconv_microscopy uses TV and ADMM, so maybe deconv_microscopy_tv_admm

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Done.

@bwohlberg
Copy link
Collaborator Author

Nice! I didn't go as far as rendering the docs, but I trust that it looks fine.

FWIW, you don't have to do it manually since the docs are built as part of the automated checks; see the Details link next to docs/readthedocs.org:scico.

@bwohlberg bwohlberg merged commit 0ae09a9 into main Oct 27, 2021
@bwohlberg bwohlberg deleted the brendt/example-rename branch October 27, 2021 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples Pertaining to SCICO examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants