Open CFGrote opened 11 months ago
I found the following issues with the documentation;
pip install -e .
pip install git+https://github.com/...@simex
mention that mpi is a requirement
why install from juncheng repo, not central WPG?
Add introductory explanation of what is being done, what are the steps
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:
Backengine installation
install from git without cloning:
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