Skip to content

Commit b516710

Browse files
committed
update setup
1 parent 3fb77b0 commit b516710

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

setup.py

+27-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,37 @@
11
import os
22
from setuptools import setup, find_packages
33

4-
with open('README.md', 'r') as file:
5-
long_description = file.read()
6-
74
module_dir = os.path.dirname(os.path.abspath(__file__))
85
with open(os.path.join(module_dir, "VERSION"), "r") as f:
96
version = f.read()
107

8+
9+
long_description = \
10+
"""
11+
rocketsled is a black-box optimization framework "on rails" for high-throughput computation with FireWorks.
12+
13+
- **Website (including documentation):** https://hackingmaterials.github.io/rocketsled/
14+
- **Help/Support:** https://groups.google.com/forum/#!forum/fireworkflows
15+
- **Source:** https://github.com/hackingmaterials/rocketsled
16+
- **FireWorks website:** https://materialsproject.github.io/fireworks
17+
18+
If you find rocketsled useful, please encourage its development by citing the [following paper](http://doi.org//10.1088/2515-7639/ab0c3d) in your research:
19+
20+
```
21+
Dunn, A., Brenneck, J., Jain, A., Rocketsled: a software library for optimizing
22+
high-throughput computational searches. J. Phys. Mater. 2, 034002 (2019).
23+
```
24+
25+
If you find FireWorks useful, please consider citing [its paper](http://dx.doi.org/10.1002/cpe.3505) as well:
26+
27+
```
28+
Jain, A., Ong, S. P., Chen, W., Medasani, B., Qu, X., Kocher, M., Brafman, M.,
29+
Petretto, G., Rignanese, G.-M., Hautier, G., Gunter, D., and Persson, K. A.
30+
FireWorks: a dynamic workflow system designed for high-throughput applications.
31+
Concurrency Computat.: Pract. Exper., 27: 5037–5059. (2015)
32+
```
33+
"""
34+
1135
setup(
1236
name='rocketsled',
1337
version=str(version),

0 commit comments

Comments
 (0)