From 5fd38844110774b4e2c8759bf5244a1135a51bcf Mon Sep 17 00:00:00 2001 From: Janosh Riebesell Date: Mon, 8 Apr 2024 16:53:35 +0200 Subject: [PATCH] add SVG logo now used in readme --- README.md | 7 +++++-- docs_rst/_static/fireworks-logo.svg | 1 + fireworks/core/launchpad.py | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 docs_rst/_static/fireworks-logo.svg diff --git a/README.md b/README.md index a26744fd6..36f29e505 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# FireWorks +

+ FireWorks +

FireWorks stores, executes, and manages calculation workflows. @@ -9,7 +11,8 @@ FireWorks stores, executes, and manages calculation workflows. If you like FireWorks, you might also like [rocketsled](https://github.com/hackingmaterials/rocketsled). If you find FireWorks useful, please consider citing the paper: -``` + +```txt Jain, A., Ong, S. P., Chen, W., Medasani, B., Qu, X., Kocher, M., Brafman, M., Petretto, G., Rignanese, G.-M., Hautier, G., Gunter, D., and Persson, K. A. (2015) FireWorks: a dynamic workflow system designed for high-throughput diff --git a/docs_rst/_static/fireworks-logo.svg b/docs_rst/_static/fireworks-logo.svg new file mode 100644 index 000000000..675c5b4d3 --- /dev/null +++ b/docs_rst/_static/fireworks-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/fireworks/core/launchpad.py b/fireworks/core/launchpad.py index b30896249..c878660aa 100644 --- a/fireworks/core/launchpad.py +++ b/fireworks/core/launchpad.py @@ -376,7 +376,9 @@ def add_wf(self, wf, reassign_all=True): Add workflow(or firework) to the launchpad. The firework ids will be reassigned. Args: - wf (Workflow/Firework) + wf (Workflow/Firework): Workflow or Firework object + reassign_all (bool): If True, the firework ids will be assigned + starting from the next available id. Defaults to True. Returns: dict: mapping between old and new Firework ids