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

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

Closed
willu47 opened this issue May 20, 2024 · 2 comments
Closed

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

willu47 opened this issue May 20, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@willu47
Copy link

willu47 commented May 20, 2024

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

@willu47 willu47 added the enhancement New feature or request label May 20, 2024
@DorsanL
Copy link
Collaborator

DorsanL commented Jul 23, 2024

Thank you for this suggestion. Entry points for test have been added.
4a63b03

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
Copy link
Collaborator

DorsanL commented Aug 30, 2024

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.

@DorsanL DorsanL closed this as completed Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants