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

Update docs on visualisation and post processing #202

Open
KAClough opened this issue Nov 22, 2021 · 0 comments
Open

Update docs on visualisation and post processing #202

KAClough opened this issue Nov 22, 2021 · 0 comments
Assignees
Labels
enhancement Modification of existing feature/general improvement

Comments

@KAClough
Copy link
Member

Review comment: The documentation links to this page for post-processing with yt. But there's no explanation on how to use these scripts. Similarly for visit. The included scripts have no comments. E.g., what is the difference between PlotSlice.py and PlotSliceRemix.py? How to use and modify these scripts?

Miren: I agree that the documentation and comments for the postprocessing tools is not up to the same standard of this code and could be improved. However, these tools are not part of this repository and should therefore not be considered an integral part of the main code. We link to them merely as examples and they are provided "as is". For your specific example of the difference between PlotSlice.py and PlotSliceRemix.py, please refer to the comments at the top of the latter where you will also find usage instructions.

Katy: It would be nice to have a little more guidance on these scripts at some point :-) Maybe we can make and link to a video from our next online training programme.

@KAClough KAClough added the enhancement Modification of existing feature/general improvement label Nov 22, 2021
@mirenradia mirenradia removed their assignment Nov 22, 2021
@mirenradia mirenradia removed their assignment Nov 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Modification of existing feature/general improvement
Projects
None yet
Development

No branches or pull requests

4 participants