diff --git a/LiquidDiffract/scripts/ld_launcher.py b/LiquidDiffract/scripts/ld_launcher.py new file mode 100644 index 0000000..051ecbe --- /dev/null +++ b/LiquidDiffract/scripts/ld_launcher.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +''' +Fallback launcher script for LiquidDiffract! +Run python ld_launcher.py + +''' +__author__ = 'Benedict J. Heinen' +__copyright__ = 'Copyright 2023, Benedict J. Heinen' +__license__ = 'GNU GPL v3' +__email__ = 'benedict.heinen@gmail.com' + +from LiquidDiffract.LiquidDiffract import main +main() diff --git a/README.md b/README.md index 5b40570..59ec74e 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Dependencies are handled automatically when installing with *pip*. The simplest way to install LiquidDiffract is directly from PyPI with pip: -```$ pip install LiquidDiffract``` +```$ python3 -m pip install LiquidDiffract``` (on Windows use: ```py -m pip install LiquidDiffract```) The source code is directly available [here](https://github.com/bjheinen/LiquidDiffract/archive/master.zip) @@ -101,7 +101,9 @@ To run the software use the command ```$ LiquidDiffract``` -or run *'LiquidDiffract.py'* from the installation directory ```$ python LiquidDiffract.py``` +If this fails setuptools may have placed the script in a directory not on your path. The location is usually a user or python specific scripts/bin folder, e.g. /usr/local/bin, ~/anaconda3/bin/, or Python\Python311\Scripts\ + +Alternatively, run *'ld_launcher.py'* from the scripts folder of the installation directory ```$ python ld_launcher.py``` ### Basic Usage