|
1 | 1 | import os
|
2 | 2 | from setuptools import setup, find_packages
|
3 | 3 |
|
4 |
| -with open('README.md', 'r') as file: |
5 |
| - long_description = file.read() |
6 |
| - |
7 | 4 | module_dir = os.path.dirname(os.path.abspath(__file__))
|
8 | 5 | with open(os.path.join(module_dir, "VERSION"), "r") as f:
|
9 | 6 | version = f.read()
|
10 | 7 |
|
| 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 | + |
11 | 35 | setup(
|
12 | 36 | name='rocketsled',
|
13 | 37 | version=str(version),
|
|
0 commit comments