Skip to content

Commit 778119c

Browse files
committed
Cleanup of paper.md
1 parent 1a6061a commit 778119c

File tree

1 file changed

+2
-28
lines changed

1 file changed

+2
-28
lines changed

joss/paper.md

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ authors:
1010
affiliation: 1
1111
corresponding: true
1212
- name: Graeme J. Kennedy
13-
orcid:
13+
orcid: 0000-0002-4223-3043
1414
affiliation: 1
1515
affiliations:
1616
- name: Georgia Institute of Technology, United States
1717
index: 1
1818
ror: 01zkghx44
19-
date: 9 October 2025
19+
date: 24 October 2025
2020
bibliography: paper.bib
2121
---
2222

@@ -243,29 +243,3 @@ x, res = interface.optimize_system(x0=x0, method="SLSQP")
243243
```
244244

245245
\normalsize
246-
247-
<!-- NOTE: this was used for the grant proposal for Flume (unsure if this got submitted); not deleting this yet, but will likely not add to the paper. To further its development and ensure its applicability for an increased number of disciplines, we propose to extend Flume in two main areas: parallelism and remote procedure calls.
248-
While there are no inherent limitations that prevent a user from enabling parallelism within specific analyses, this has not been a development focus to date.
249-
However, to support large computing effort, we aim to implement and test parallel execution features.
250-
Additionally, since one of the primary benefits of Flume is the automatic management and communication between _Analysis_ instances in a _System_, it also lends itself to remote procedure calls.
251-
In scenarios where certain information or _Analysis_ instances can only be performed on secure machines but cannot be conducted entirely in this location, a remote procedure call is necessary and could be facilitated with a framework that automates data distribution.
252-
With these additional applications, the framework would be further equipped to solve a breadth of MDO problems that are discipline independent. -->
253-
254-
<!-- # To-do List
255-
256-
- DONE: Draft two paragraphs and potentially an image explaining Flume. Intent is to use this for the grant proposal, as well as the _Summary_ or _Statement of Need_ section for JOSS submission
257-
- Should mention stuff about parallelism and remote procedures for the grant proposal version
258-
- TODO: Start to populate this file with the metadata for the JOSS submission
259-
- DONE: Document the code that has missing docstrings; ensure to follow the proper format with arguments, kwargs, etc.
260-
- DONE: Construct an interface between Flume and Scipy, which can be used upon installation of Flume (unlike ParOpt, which requires additional dependencies)
261-
- DONE: Implement a few more unittests that will perform optimization checks (for Rosenbrock and something else) and integration with Scipy minimize
262-
- DONE: update examples directory to reflect the current structure of the code; i.e. remove any examples that do not use updated Analysis/System classes; make sure that there are a few different examples covering a variety of disciplines
263-
- examples to include: Hohmann transfer from OpenMDAO (opt), Rosenbrock (opt), multi-objective (demonstrating more complex system construction), COPS sphere problem (opt)
264-
- DONE: add beam example from OpenMDAO
265-
- DONE: add a script/jupyter notebook/something that details the useful helper methods and outlines how to start constructing a Flume example (want to incorporate adjoint test methods, network visualization, etc.)
266-
- TODO: update README.md with installation instructions, and point the user to various helpful portions of the documentation (e.g. new users check out the Jupyter notebook, for descriptive details point to the paper, etc.); make this homepage for the RTD
267-
- TODO: Documentation/RTD website page
268-
- include the overview and methods files in the RTD page
269-
- API
270-
- DONE: determine where to add info about SciPy and ParOpt interfaces
271-
-->

0 commit comments

Comments
 (0)