Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,35 @@ Or, to install from source:
pip install git+https://github.com/quantum-programming/pygridsynth.git
```

### Install executable

You can optionally install an executable script called `pygridsynth` with

```bash
pip install .
```

Or, to install in development (editable) mode

```bash
pip install -e .
```

The versions of `pygridsynth` available on pypi do not yet support
installing an executable in this way.

Once you have installed this executable, you can use `pygridsynth` like this

```sh
shell> pygridsynth <theta> <epsilon> [options]
```

or `pygridsynth --help` for brief information on calling the script.

## Usage

`pygridsynth` can be used as a command-line tool.
`pygridsynth` can be used as a command-line tool even if you have not installed the
executable.

### Command-Line Example

Expand Down
2 changes: 2 additions & 0 deletions pygridsynth/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
from .gridsynth import *

from .__main__ import main
9 changes: 9 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from setuptools import setup, find_packages

setup(
entry_points={
'console_scripts': [
'pygridsynth = pygridsynth.__main__:main',
],
}
)