PaNOSC-ViNYL / SimEx-Lite

The core package of the SIMEX platform providing the calculator interfaces. https://simex-lite.readthedocs.io/
Other
1 stars 5 forks source link

Improve documentation #40

Open CFGrote opened 11 months ago

CFGrote commented 11 months ago

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

WPG:

why install from juncheng repo, not central WPG?

Usage

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