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

Further Improvements to Documentation #129

Open
rob-shalloo opened this issue Apr 25, 2023 · 1 comment
Open

Further Improvements to Documentation #129

rob-shalloo opened this issue Apr 25, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rob-shalloo
Copy link
Member

rob-shalloo commented Apr 25, 2023

Just collating some next steps regarding the documentation:

  • We should decide on the format for examples. A good idea from Ángel (who has implemented this on Wake-T) is to write the page, including python code and rst code into a .py file in a tutorial folder and then have sphinx autogenerate the page. An example is here: https://github.com/AngelFP/Wake-T/blob/master/tutorials/01_single_plasma_simulation.py with the rendering here https://wake-t.readthedocs.io/en/latest/tutorials/01_single_plasma_simulation.html#sphx-glr-tutorials-01-single-plasma-simulation-py
  • It would be good to have a handful tutorials covering as broad a range of the code as possible. Perhaps if we can streamline/simplify the creation process then we can add more tutorials as good first issues
  • The Overview of the Code section would be, I think, quite a nice place to elaborate on the reason for developing the code as well as some documentation relating to the standards adopted in the output files, representations of the pulse internal (similar to our recent z vs t representation discussion) etc etc. It would be nice if the basics were clear and easy to find without delving into the source code. We can also add a section on some general theory (perhaps for propagator or other). Also would be nice to have a list of codes (which can be updated continuously) which support lasy input
@rob-shalloo rob-shalloo added the documentation Improvements or additions to documentation label Apr 25, 2023
@RemiLehe
Copy link
Member

Discussed offline with @MaxThevenet @AngelFP: we should add some documentation that describes these new features:
#139 #126

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
Projects
None yet
Development

No branches or pull requests

2 participants