Skip to content

Commit b80bc72

Browse files
committed
Added project fields and documentation of pip install with optional dependencies
Signed-off-by: Greg von Winckel <[email protected]>
1 parent 138ec86 commit b80bc72

File tree

2 files changed

+53
-3
lines changed

2 files changed

+53
-3
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,39 @@ Optional dependencies include:
2525
* pyswarms (Particle Swarm Optimization)
2626

2727
## Installation
28-
1. To install PyTUQ from source, start up a Python virtual environment and clone the repository:
28+
29+
### Basic Installation
30+
Install PyTUQ with core dependencies:
31+
```bash
32+
$ pip install pytuq
33+
```
34+
35+
#### Optional Features
36+
37+
Install additional features as needed:
38+
* Neural network surrogates
39+
```bash
40+
$ pip install pytuq[nn]
41+
```
42+
43+
* Particle swarm optimization
44+
```bash
45+
$ pip install pytuq[optim]
2946
```
47+
48+
* All optional features
49+
```bash
50+
pip install pytuq[all]
51+
```
52+
53+
* Development tools
54+
```bash
55+
pip install pytuq[dev]
56+
```
57+
58+
### Installation from Source
59+
1. To install PyTUQ from source, start up a Python virtual environment and clone the repository:
60+
```bash
3061
$ source <PYTHON_VENV_DIR>/bin/activate
3162
$ git clone [email protected]:sandialabs/pytuq.git
3263
$ cd pytuq
@@ -46,4 +77,4 @@ Distributed under BSD 3-Clause License. See `LICENSE.txt` for more information.
4677
## Acknowledgements
4778
This work is supported by the Scientific Discovery through Advanced Computing (SciDAC) Program under the Office of Science at the U.S. Department of Energy.
4879

49-
Sandia National Laboratories is a multimission laboratory managed and operated by National Technology & Engineering Solutions of Sandia, LLC, a wholly owned subsidiary of Honeywell International Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA0003525.
80+
Sandia National Laboratories is a multimission laboratory managed and operated by National Technology & Engineering Solutions of Sandia, LLC, a wholly owned subsidiary of Honeywell International Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA0003525.

pyproject.toml

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,34 @@ dependencies = [
3737
"matplotlib",
3838
]
3939

40+
[project.urls]
41+
Homepage = "https://sandialabs.github.io/pytuq/"
42+
Repository = "https://github.com/sandialabs/pytuq"
43+
Documentation = "https://sandialabs.github.io/pytuq/"
44+
45+
4046
[project.optional-dependencies]
4147
dev = [
4248
"pytest>=7.0",
4349
"pytest-cov"
4450
]
51+
nn = [
52+
"torch",
53+
"quinn @ git+https://github.com/sandialabs/quinn.git"
54+
]
55+
optim = [
56+
"pyswarms"
57+
]
58+
all = [
59+
"torch",
60+
"quinn @ git+https://github.com/sandialabs/quinn.git",
61+
"pyswarms"
62+
]
63+
4564

4665
[tool.setuptools.packages.find]
4766
where = ["src"]
4867
namespaces = false
4968

5069
[tool.setuptools]
51-
package-dir = {"" = "src"}
70+
package-dir = {"" = "src"}

0 commit comments

Comments
 (0)