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

Improve documentation #40

Open
CFGrote opened this issue Oct 6, 2023 · 0 comments
Open

Improve documentation #40

CFGrote opened this issue Oct 6, 2023 · 0 comments

Comments

@CFGrote
Copy link
Contributor

CFGrote commented Oct 6, 2023

I found the following issues with the documentation;

Quickstart expectations: I would expect an example simulation as part of a quickstart, not just instructions for installation.

Redundant sections: Introduction/Quickstart and Users/Installation are more or less identical, remove one of them

installation uses python setup.py which is kind of old fashioned. pip install -e . is the way to go.

Calculators: Really just one Calculator? Can we have more?

PhenomSourceCalculator:

  • should describe that this is a XFEL pulse and how it is modeled
  • being picky: Why do we need all this wpg stuff, can't we put all that in some common namespace or (better) provide wrappers for common plotting tasks?
  • While at it, should also show how to use the sampling check in wpg.
  • also, since backengine installation only comes next, wpg might not be available, yet

Backengine installation

install from git without cloning:

pip install git+https://github.com/...@simex

mention that mpi is a requirement

WPG:

why install from juncheng repo, not central WPG?

Usage

Add introductory explanation of what is being done, what are the steps

  • add comments to code
  • turn doi into html
  • explain the img_gaussian parameters
  • What does "Larger slop and intercept gets larger noise" mean?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant