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

Add command line scripts / entry points via pip installation #942

Open
aaronkho opened this issue Apr 3, 2025 · 0 comments
Open

Add command line scripts / entry points via pip installation #942

aaronkho opened this issue Apr 3, 2025 · 0 comments

Comments

@aaronkho
Copy link

aaronkho commented Apr 3, 2025

TORAX offers a number of utility scripts to improve user interaction. However, the current recommended method of executing them is via python3 <path_to_script_in_torax_repo>. It would be easier to work with TORAX if these were converted to simple terminal commands upon pip installation of TORAX, which I understand is possible via the pyproject.toml and setuptools.

For example:
python3 <path_to_torax_repo_top>/torax/plotting/plotruns.py --outfile <full_path_to_simulation_output>
could become
torax_plot --outfile <path_to_simulation_output>

Ideally, the latter can be run from anywhere in the filesystem if TORAX is installed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant