hema-ted / pyzfs

A python package to compute zero-field-splitting tensors for molecules and spin quantum bits in semiconductors.
MIT License
11 stars 10 forks source link

Use entry point for command line interaction #3

Closed malramsay64 closed 4 years ago

malramsay64 commented 4 years ago

I will just note that this isn't a requirement of acceptance of the review, and more an easy improvement I noticed.

In the setup.py file it is possible to specify an entry_point, that is adding an executable to the path which points to a function through the console_scripts entry point. This article describes everything in more detail and the setuptools documentation also includes a description of using this functionality.

This allows for using runzfs instead of python -m pyzfs.exec.runzfs and removes the need to update the PYTHON_PATH environment variable. An example of the changes required while keeping backwards compatibility are in #2. There are additional updates to the documentation which would be required if you see this change as helpful.

malramsay64 commented 4 years ago

Fixed by #2