[JOSE] Documentation/Readme possible improvements

[BenjMy]

xref openjournals/jose-reviews#185

• README

  • Make clear that Gempy is an optional dependency in the README.
  • Identify the target audience in the docs and in the README.
  • Add briefly FAIR principles adopted for the datasets

• Documentation:

  • The installation section is a bit confusing. I would only add 2 clear installations: (1) Installing using Conda/Pip (2) Installation of a developer version. Particularly I don't understand why you recommend "installing Gemgis dependencies manually" after "Installing GemGIS via conda-forge". I would expect the required dependencies installed automatically.
    Notebooks recommandations
    • See [JOSE] Pedagogy / Instructional design #18
    • I often found very useful to have a button to be able to download the notebook directly from the documentation (see Sphinx doc).

[jwagemann]

• The repository misses a description on dependencies and environment settings via e.g. an environment.yml file → how can I replicate the setup to have the notebooks of the tutorial running?
• The link to the binder does not open an environment where I can run the tutorial notebooks → it leads to the GemGIS binder setup
• I cannot see a version indicated on the repository
• License of repository (GPL 3.0) and license identified on the notebooks (CC-BY) differ

[AlexanderJuestel]

Also, here a list of your comments to track my progress of the revision:

• Make clear that Gempy is an optional dependency in the README.

• Identify the target audience in the docs and in the README.

• Add briefly FAIR principles adopted for the datasets

• The installation section is a bit confusing. --> Fixing the installation

• I often found very useful to have a button to be able to download the notebook directly from the documentation (see Sphinx doc).

• The repository misses a description on dependencies

• The repository misses a description environment settings via e.g. an environment.yml file → how can I replicate the setup to have the notebooks of the tutorial running?

• The link to the binder does not open an environment where I can run the tutorial notebooks → it leads to the GemGIS binder setup

• I cannot see a version indicated on the repository

• License of repository (GPL 3.0) and license identified on the notebooks (CC-BY) differ