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.

Sign up for GitHub

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

Jump to bottom

Docs #213

Merged
merged 42 commits into from
Oct 1, 2024
Merged

Docs #213

merged 42 commits into from
Oct 1, 2024

Conversation

plesiopterys
Copy link
Contributor

  • made toc tree two levels on the secondary navigation on the right hand side (e.g. now instruments show up in the API)
  • added advanced notebooks under the advanced tab
  • fixed the notebooks to have markdown titles so they show up on sphinx

plesiopterys and others added 30 commits April 3, 2024 19:03
@plesiopterys
linked nb to root folder, deleted dupes
a91f4cb
@plesiopterys
added requirements nbsphinx-link pytest
7e8c458
@plesiopterys
renamed example 6 in notebooks.rst so file gets included
36c96da
@plesiopterys
new branch
cdd0b0b
@plesiopterys
Merge branch 'main' of https://github.com/sandialabs/pyscan into plot…
7bdc4ac 
…ting
@plesiopterys
testing in progress
b773f5c
@plesiopterys
feature: plot generator handles 3D data for 2D plots
9d28493
@plesiopterys
update from main
638c4dc
@plesiopterys
docstrings fixed to not have Properties (breaking the docs build)
591b497
@plesiopterys
trying to make docs build
e55062c
@plesiopterys
flake8 fix
d4c25be
@plesiopterys
flake8 fix
352e68f
@plesiopterys
Update __init__.py
0b746f6 
add newline
@rsbrost
Merge branch 'main' of https://github.com/sandialabs/pyscan into plot…
2ad8630 
…ting
@rsbrost
implemented experiment killswitch into live_plot_funtion so that user…
d9b9796 
…s can stop their experiment while liveplotting with a push of a button.
@rsbrost
added note for using this new feature.
dba302d
@rsbrost
additionally implemented killswitch in experiment.py. May want to onl…
241fee2 
…y implement killswitch here since it is still implemented in liveplot; however, having it in both places allows for additional functionality which may be desireable, or overly complex. Consult with Andy when deliberating over this.
@rsbrost
added killswitch ability to experiments that can run liveplots while …
1e39892 
…listening for killswitch key to be pressed. This will stop the experiment at any time. I also added a demo notebood as an example of how to use this. It looks like I may have made unintended changes to live_plot.py and or experiment.py SO PLEASE VERIFY THAT THESE FILES WERE NOT CHANGED IN ANY SIGNIFICANT WAY!
@rsbrost
including the killswitch demo_nb in this commit since I moved it out …
e717e33 
…of it's own folder and into the main. It would be a good idea to validate that this doesn't break the demonb test cases on the github build workflow.
@rsbrost
fix: tried updating killswitch example notebook to skip last cell on …
cd2b930 
…nbmake workflow.
@rsbrost
deleting extranneous files
1be0de8
@rsbrost
merged from main
f36280f
@rsbrost
updated keithley2260b doc string to match other syntax for documentat…
a7af1f8 
…ion.
@rsbrost
updated syntax to be kill_switch rather than killswitch
3e204d1
@rsbrost
removing kill switch from plotting branch.
63205b9
@rsbrost
cleaning up...
37c1fc6
@rsbrost
cleaning up...
c66064a
@rsbrost
chore: pulled from main.
f999285
@plesiopterys
feat: Added live_multi_plot function
3502a7d
@plesiopterys
fixed live multiplot display issues
9897f3a
i-am-mounce
i-am-mounce reviewed Aug 20, 2024
View reviewed changes
pyscan/general/get_pyscan_version.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

this needs to be moved to new branch.

i-am-mounce
i-am-mounce reviewed Aug 20, 2024
View reviewed changes
pyscan/__init__.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Tag this as a fix

rsbrost
rsbrost approved these changes Sep 26, 2024
View reviewed changes
Copy link
Contributor

@rsbrost rsbrost left a comment

Choose a reason for hiding this comment

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

These changes are relatively simple and all make sense to me. I think this is ready to pull; however, I'll wait for Andy to verify.

@rsbrost rsbrost merged commit e86c3f5 into main Oct 1, 2024
3 checks passed
i-am-mounce pushed a commit that referenced this pull request Oct 1, 2024
Merge pull request #213 from sandialabs/docs
d999669 
Docs [skip ci]
@i-am-mounce i-am-mounce deleted the docs branch October 4, 2024 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@i-am-mounce i-am-mounce i-am-mounce approved these changes

@rsbrost rsbrost rsbrost approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@plesiopterys @i-am-mounce @rsbrost