[JOSS Review]: Use entry point for getting started

IPESE / REHO

Master version of the model

Apache License 2.0

6 stars 10 forks source link

[JOSS Review]: Use entry point for getting started #23

Closed willu47 closed 1 month ago

willu47 commented 4 months ago

Summary

Instead of requiring users to manually download a folder of data and a script from the repository, develop a simple command-line interface and a test or setup console script which automates this process.

Detailed design

A command such as $ reho setup would download (or copy from the installed package) the required data and scripts to the current folder and then execute them.

Notes and comments

No response

DorsanL commented 2 months ago

Thank you for this suggestion. Entry points for test have been added. https://github.com/IPESE/REHO/commit/4a63b03aec4f85ae097582e4bd1ab2c3b5d03e0c

The "Checking proper installation" section of the documentation has been updated accordingly. https://reho.readthedocs.io/en/main/sections/5_Getting_started.html#checking-proper-installation

DorsanL commented 1 month ago

Available entry points are:

reho-test-import
reho-test-run
reho-download-examples

They allow to verify the proper installation of REHO (import, run, plot), and to download available examples for people who have installed the package and not cloned the full repository.