Skip to content

Add tutorial for basic interaction with windows - #5

Closed
emeyer121 wants to merge 190 commits into
LabForComputationalVision:mainfrom
plenoptic-org:add_basic_use_tutorial
Closed

Add tutorial for basic interaction with windows#5
emeyer121 wants to merge 190 commits into
LabForComputationalVision:mainfrom
plenoptic-org:add_basic_use_tutorial

Conversation

@emeyer121

@emeyer121 emeyer121 commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Added a tutorial to the documentation with the goal of covering the ways users will primarily interact with PoolingWindows. This includes the following:

  • how to generate windows
  • what arguments can be set in PoolingWindows
  • how to generate windows with create_pooling_windows
  • show the plotting functions
  • how to choose a scaling value

Outstanding questions:

  • anything I'm missing that should be included here?
  • for displaying the window values, I am currently just generating some noisy image. In plenoptic there are built in images, loading, etc which feels like overkill but curious if you think it'd be helpful to have a default image here

emeyer121 added 30 commits June 10, 2026 15:58
@emeyer121
added minimal pyproject.toml
de829f1
@emeyer121
moved files into src/pooling-windows/
c831c5d
@emeyer121
fixed naming to pass pytest
eae576f
@emeyer121
added setuptools to pyproject.toml
10aeda0
@emeyer121
removed requirements.txt file
f99bbee
@emeyer121
added basic ruff tools for formatting and linting
042317a
@emeyer121
Revert "removed requirements.txt file"
bcc31b7 
This reverts commit f99bbee.
@emeyer121
removed requirements.txt file
d8baef1
@emeyer121
added setuptools_scm version scheme to pyproject.toml
7f915c2
@emeyer121
added additional codespell info to pyproject.toml
a703b16
@emeyer121
removed unnecessary pyrtools from pyproject.toml and pooling.py examples
0ed64b0
@emeyer121
removed codespell until pre-commit is functional
0e0ddfa
@emeyer121
formatting and linting in progress, few issues remaining
1f40d68
@emeyer121
Merge pull request #1 from emeyer121/initial_packaging
6c5a338 
Initial packaging of code using ``pyproject.toml`` and removing ``requirements.txt`` as well as some unnecessary imports.
@emeyer121
fixing conflicts with pyproject.toml
858c81a
@emeyer121
fixed pre-commit issues in __init__.py
960bdbc
@emeyer121
all pre-commit issues fixed except unused variables in test_pooling.py
9932a85
@emeyer121
Merge branch 'main' into add_precommit
831e59b
@emeyer121
fixing conflicts in pyproject.toml
1f89395
@emeyer121
final pre-commit edits for current rules
e488c14
@emeyer121
Merge pull request #2 from emeyer121/add_precommit
9e63a82 
Add pre-commit and ensured everything passes for current rules implemented.
@emeyer121
initial job for github CI workflow
e348c3f
@emeyer121
minor fix
9a36fb9
@emeyer121
updates to pytest workflow in ci.yml and pyproject.toml
cdd17c4
@emeyer121
adding zizmor to github workflow
5e4f9f0
@emeyer121
remove old tests.yml file
b463883
@emeyer121
fixing pytest options
7efcf9d
@emeyer121
fixing various references to plenoptic
589be5b
@emeyer121
Merge pull request #3 from emeyer121/add_github_workflow
34470cc 
Add GitHub workflow
@emeyer121
fixed python versions and installation details in README.md
abf68e4
emeyer121 added 26 commits July 13, 2026 12:24
@emeyer121
Merge pull request #8 from emeyer121/setup_docs_sphinx
e66e101 
Setup sphinx, add docs, and add remaining ruff rules
@emeyer121
Merge pull request #10 from emeyer121/reorg_code
11c18ed 
High-level reorganization of code
@emeyer121
Merge branch 'main' of github.com:emeyer121/pooling-windows into add_…
d664ebb 
…tutorials_to_docs
@emeyer121
Merge branch 'main' of github.com:emeyer121/pooling-windows into add_…
b02a705 
…basic_use_tutorial
@emeyer121
Merge branch 'main' of github.com:emeyer121/pooling-windows into prin…
86604e9 
…t_windows_summary
@emeyer121
Trigger CI
cea05de
@emeyer121
Trigger CI
c63d442
@emeyer121
turned print statement into string output
f3b63e1
@emeyer121
fix relevant test
9853dc7
@emeyer121
Revert "fix relevant test"
7d85721 
This reverts commit 9853dc7.
@emeyer121
fix relevant test
84f57ba
@emeyer121
Merge branch 'print_windows_summary' of github.com:emeyer121/pooling-…
83ebe57 
…windows into add_basic_use_tutorial
@emeyer121
edits to tutorial
dc4cbff
@emeyer121
remove from git tracking
e40f029
@emeyer121
Trigger CI for readthedocs test
baedd1f
@emeyer121
change to fail on warning
98248ce
@emeyer121
changed animation to not rely on ffmpeg
521627b
@emeyer121
edit defaults for conf.py
5a83507
@emeyer121
fix docstrings related to conf.py changes
d3b028d
@emeyer121
fix download file name
cd3da65
@emeyer121
remove from git tracking
5399031
@emeyer121
Merge branch 'add_tutorials_to_docs' of github.com:emeyer121/pooling-…
32b0048 
…windows into add_basic_use_tutorial
@emeyer121
flipped sign in sampling to fix reversed functions
6d69c72
@emeyer121
Merge branch 'add_tutorials_to_docs' of github.com:emeyer121/pooling-…
fa65887 
…windows into add_basic_use_tutorial
@emeyer121
minor text updates
e9e46ae
@emeyer121
move sections
96f549e
@emeyer121 emeyer121 closed this Jul 21, 2026
@emeyer121 emeyer121 reopened this Jul 21, 2026
@emeyer121 emeyer121 closed this Jul 21, 2026
@emeyer121

emeyer121 commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

Accidentally had this PR merge with the original repo rather than my fork. See actual PR here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@emeyer121