add SVG logo now used in readme

materialsproject · Apr 8, 2024 · 5fd3884 · 5fd3884
1 parent e73ba9f
commit 5fd3884
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-# <img alt="FireWorks" src="docs_rst/_static/FireWorks_logo.png" width="250">
+<h1 align="center">
+  <img alt="FireWorks" src="docs_rst/_static/fireworks-logo.svg" width="350">
+</h1>
 
 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
diff --git 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