Skip to content

Make source code pip-installable and command line interface#1

Open
hdsassnick wants to merge 2 commits intoaimat-lab:mainfrom
hdsassnick:pip_installable_and_CLI
Open

Make source code pip-installable and command line interface#1
hdsassnick wants to merge 2 commits intoaimat-lab:mainfrom
hdsassnick:pip_installable_and_CLI

Conversation

@hdsassnick
Copy link
Copy Markdown

@hdsassnick hdsassnick commented Dec 2, 2025

This PR adds the following enhancements/fixes:

  • It adds the pyproject.toml file such that the package can be distributed via pypi and installed via pip.
  • It adds the CLI 'pal_engine' to be called instead of 'python main.py'.
  • All settings can be passed via command line arguments as well as a json-file or the original Python file.
  • The typo dynamic_oracle_list is now deprecated.

TO-DOs:

  • Update README.
  • Add dependencies to pyproject.toml.

@zzc558: it would be great if you could double-check that the functionality is maintained. You should be able to pull this branch and run pip install . in the source directory (with the pyproject.toml file). And then mpirun pal_engine -sf al_setting.py in the 'project' directory. Everything else should work the same way as before. Your feedback is highly appreciated. If you agree with the changes, I would finish the TO-DOs and the PR can be merged.

Edit: All to-dos are done. This PR would be ready to be merged.

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

Successfully merging this pull request may close these issues.

1 participant