Skip to content

Commit 58bbac9

Browse files
committed
docs: update for new API
1 parent 456ca72 commit 58bbac9

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,23 @@ pip install apbs-binary
1313
```
1414

1515
```python
16-
from apbs_binary import APBS_BIN_PATH, MULTIVALUE_BIN_PATH, apbs, multivalue, process_run
16+
from apbs_binary import run_apbs, popen_apbs, run_multivalue, popen_multivalue
1717

18-
# Run apbs
19-
print(APBS_BIN_PATH)
20-
apbs("--help")
18+
run_apbs("--help") # like subprocess.run(["apbs", "-h"])
19+
popen_apbs("--help") # like subprocess.Popen(["apbs", "-h"])
20+
21+
# For no-argument case, pass an empty string
22+
run_apbs("") # like subprocess.run(["apbs"])
23+
24+
# Pass a list of arguments
25+
run_apbs(["-Trim", "input.pdb"])
2126

2227
# Run multivalue
23-
print(MULTIVALUE_BIN_PATH)
24-
multivalue()
28+
run_multivalue(...)
29+
popen_multivalue(...)
2530
```
2631

27-
The other tools are also available, but not all of them have the function wrappers. Use as `apbs_binary.process_run("analysis", "--help")` for example.
32+
The other tools are also available. Use as `apbs_binary.run_analysis("--help")` for example.
2833

2934
Supported platforms:
3035

@@ -33,7 +38,8 @@ Supported platforms:
3338

3439
> [!NOTE]
3540
> Installing the package does NOT put the binary in $PATH.
36-
> Instead, the API will tell you where it is located.
41+
> If you need to directly execute the binary, you can execute `apbs_binary.APBS_BIN_PATH` on Linux.
42+
> For macOS, the environment variable `DYLD_LIBRARY_PATH` must be set to `apbs_binary.LIB_DIR`.
3743
3844
## 👨‍💻️ Maintenance Notes
3945

0 commit comments

Comments
 (0)