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

Add specific docs for the GUI #315

Merged
merged 10 commits into from
Jul 31, 2023
Merged

Conversation

lukashergt
Copy link
Collaborator

@lukashergt lukashergt commented Jul 17, 2023

This PR adds documentation for the use of the anesthetic GUI, and for how to use it when your data was not generated with PolyChord or MultiNest.

This came up in a discussion with @mj-will, who tried to apply the GUI to his samples, which are obviously not formatted in the same way as PolyChord or MultiNest.

To-Do:

Checklist:

  • I have performed a self-review of my own code
  • My code is PEP8 compliant (flake8 anesthetic tests)
  • My code contains compliant docstrings (pydocstyle --convention=numpy anesthetic)
  • New and existing unit tests pass locally with my changes (python -m pytest)
  • I have added tests that prove my fix is effective or that my feature works
  • I have appropriately incremented the semantic version number in both README.rst and anesthetic/_version.py

@lukashergt lukashergt added the docs Documentation upgrades label Jul 17, 2023
@lukashergt lukashergt self-assigned this Jul 17, 2023
@codecov
Copy link

codecov bot commented Jul 17, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (a9e1ea5) 100.00% compared to head (6644f8f) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #315   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           33        33           
  Lines         2807      2807           
=========================================
  Hits          2807      2807           
Files Changed Coverage Δ
anesthetic/_version.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lukashergt lukashergt mentioned this pull request Jul 19, 2023
6 tasks
@lukashergt
Copy link
Collaborator Author

Check out docs here:
https://anesthetic.readthedocs.io/en/gui_docs/

@lukashergt
Copy link
Collaborator Author

@mj-will, is the blue box in these new docs helpful in getting the GUI to work manually?
Any suggestions on how to improve things?

@mj-will
Copy link

mj-will commented Jul 21, 2023

@lukashergt, I think the blue box looks good and the code works for me.

One thought, given how popular jupyter notebook/kernels are, you could add a note saying you'll need to use an interactive matplotlib backend (e.g. %matplotlib notebook) but that the user's mileage may vary (in my case it works but is pretty slow).

@lukashergt lukashergt merged commit ae8ee9d into handley-lab:master Jul 31, 2023
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation upgrades
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants