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

Documentation required #98

Open
stewartboogert opened this issue Aug 27, 2023 · 3 comments
Open

Documentation required #98

stewartboogert opened this issue Aug 27, 2023 · 3 comments
Assignees
@lnevay @stewartboogert
Labels
documentation Improvements or additions to documentation

Comments

@stewartboogert
Copy link
Member

stewartboogert commented Aug 27, 2023 •
edited
Loading

  • Manual for cutters (using the cut output)
  • Manual for CLI (cutters etc) Lost doc from bitbucket
  • Example of FLUKA running
@stewartboogert stewartboogert added the documentation Improvements or additions to documentation label Aug 27, 2023
@lnevay
Copy link
Contributor

lnevay commented Aug 27, 2023

CLI was documented but this was removed apparently.

https://bitbucket.org/jairhul/pyg4ometry/annotate/develop/docs/source/cli.rst?at=develop

Minimal as it was.

@gipert
Copy link
Member

gipert commented Sep 4, 2023

Also: this section on the online docs: https://pyg4ometry.readthedocs.io/en/latest/manual/installation.html needs to be updated with the latest instructions.

@gipert gipert mentioned this issue Sep 4, 2023
Closed
@gipert
Copy link
Member

gipert commented Oct 21, 2024

Also missing: visualization output of the example in the README/RTD homepage

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

@lnevay lnevay

@stewartboogert stewartboogert

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lnevay @stewartboogert @gipert