Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@tjkessler
tjkessler committed Mar 25, 2021
1 parent 757b855 commit 165e513
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ There are currently no additional dependencies for alvaDescPy, however it requir

## Basic Usage

alvaDescPy assumes the location of alvaDesc's command-line interface is located at ```C:\Program Files\Alvascience\alvaDesc\alvaDescCLI.exe```. If alvaDesc is located in a different location, you can change the path:
alvaDescPy assumes the location of alvaDesc's command-line interface is located at your OS's default location. If alvaDesc is located in a different location, you can change the path:

```python
from alvadescpy import ALVADESC_PATH
from alvadescpy import CONFIG

ALVADESC_PATH = '\\path\\to\\alvaDescCLI.exe'
CONFIG['alvadesc_path'] = '\\path\\to\\alvaDescCLI'
```

alvaDescPy provides direct access to all alvaDesc command line arguments via the "alvadesc" function:
Expand Down

0 comments on commit 165e513

Please sign in to comment.