Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Joss paper md files #69

Merged
merged 63 commits into from
Oct 16, 2023
Merged
Changes from 1 commit
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
d3d004c
Add Joss paper templates.
marjanalbooyeh Jul 31, 2023
afa7ab2
Pulling in first draft
RainierBarrett Aug 25, 2023
c303d1e
Merge branch 'main' into joss
marjanalbooyeh Oct 5, 2023
e4aaee0
transfer citations
marjanalbooyeh Oct 5, 2023
291cb51
transfer text from overleaf
marjanalbooyeh Oct 5, 2023
cc30848
remove abstract from bib
marjanalbooyeh Oct 5, 2023
c223439
test citation
marjanalbooyeh Oct 5, 2023
3fb59e0
add availability section
marjanalbooyeh Oct 5, 2023
260c270
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 5, 2023
c7506dc
summarize bib items
marjanalbooyeh Oct 5, 2023
f30172f
fix citation
marjanalbooyeh Oct 5, 2023
3d086a1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 5, 2023
2017f63
package name in
marjanalbooyeh Oct 5, 2023
a93b33e
clean up statement of need
chrisjonesBSU Oct 5, 2023
74633eb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 5, 2023
0fd33f5
add text about Jankflow and building blocks
marjanalbooyeh Oct 6, 2023
b0ddbce
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 6, 2023
0dfc579
more progress in recipes and building blocks
chrisjonesBSU Oct 6, 2023
141f8cc
Merge branch 'joss' of github.com:cmelab/JankFlow into joss
chrisjonesBSU Oct 6, 2023
2e2c8fb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 6, 2023
08b411c
polishing text
marjanalbooyeh Oct 6, 2023
d1d68de
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 6, 2023
c79677c
add code block for welding and tensile
marjanalbooyeh Oct 6, 2023
97dccfa
add code block for welding and tensile
marjanalbooyeh Oct 6, 2023
7d75d2c
add citations
marjanalbooyeh Oct 6, 2023
c280bcf
add new citations
marjanalbooyeh Oct 6, 2023
f83a6b7
add wetting and welding citations
marjanalbooyeh Oct 6, 2023
fa5d847
minor fixes
marjanalbooyeh Oct 9, 2023
4e98fa9
add yml file for creating joss pdf
marjanalbooyeh Oct 9, 2023
749d62d
add branch name to yml file
marjanalbooyeh Oct 9, 2023
a917502
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 9, 2023
a9bd420
add pull_request flag
marjanalbooyeh Oct 9, 2023
0b6922e
Merge branch 'main' into joss
marjanalbooyeh Oct 10, 2023
3373db6
change package title in paper.md
marjanalbooyeh Oct 10, 2023
c56f8eb
update config on draft-pdf.yml
marjanalbooyeh Oct 10, 2023
a1efbde
Minor grammar/wording fixes
RainierBarrett Oct 11, 2023
faa4d4d
Expand recipes section
RainierBarrett Oct 11, 2023
7555d48
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 11, 2023
22847a0
remove code block
marjanalbooyeh Oct 11, 2023
f92ff36
Merge remote-tracking branch 'origin' into joss
marjanalbooyeh Oct 11, 2023
b9daf9d
change branch in draft-pdf yml
marjanalbooyeh Oct 11, 2023
c76bf3e
fix citation format
marjanalbooyeh Oct 11, 2023
d0c6aa3
update gmso ref
marjanalbooyeh Oct 11, 2023
3a46a07
Merge branch 'main' into joss
marjanalbooyeh Oct 12, 2023
7ea36dd
add acknowlegments
marjanalbooyeh Oct 12, 2023
8e4f832
change trigger path in action
marjanalbooyeh Oct 12, 2023
ec85a8d
fix citation
marjanalbooyeh Oct 12, 2023
4a33b6d
Restructure recipe section to be more recipe-like
RainierBarrett Oct 13, 2023
87fc6ee
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 13, 2023
f3a11e2
Additional closing wordage, separate paragraph
RainierBarrett Oct 16, 2023
4e6f8d4
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 16, 2023
67a2000
adding a word
chrisjonesBSU Oct 16, 2023
ef63a76
Merge branch 'joss' of github.com:cmelab/flowerMD into joss
chrisjonesBSU Oct 16, 2023
df2d2b6
Update paper.md
erjank Oct 16, 2023
ef7c5f3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 16, 2023
dfba8ac
add a few citations, edit gmso citation
marjanalbooyeh Oct 16, 2023
df0ee82
add parmed, openmm and pyPRISM citations
marjanalbooyeh Oct 16, 2023
a0b7631
Merge branch 'joss' of github.com:cmelab/flowerMD into joss
marjanalbooyeh Oct 16, 2023
544ddaa
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 16, 2023
f4ceaa0
update push path
marjanalbooyeh Oct 16, 2023
5f214a4
Merge branch 'joss' of github.com:cmelab/flowerMD into joss
marjanalbooyeh Oct 16, 2023
3ea3259
Added COI statement
erjank Oct 16, 2023
741f97d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,23 @@ including common polymers, forcefields, and bulk system initialization algorithm

# Recipes
`flowerMD` offers the following two ready-to-go recipes to illustrate how the design creates
potential for expanding the library of open-source and version-controlled workflows. The included example
code demonstrates how the modularity of `flowerMD` allows use and re-use of workflows, using
pre-built recipe subclasses included in the repository: `SlabSimulation`, `WeldSimulation`, and `Tensile`.
This script creates two "slabs" of polyethylene, simulates welding at their interface, then simulates a tensile
test of the resultant weld. Note that each of these steps can be run independently, and each simulation
potential for expanding the library of open-source and version-controlled workflows. The example
code included in this repository demonstrates how the modularity of `flowerMD` allows use and re-use of workflows, using
pre-built "recipe steps" (subclasses) included in the repository:
`flowerMD.modules.welding.SlabSimulation`, `flowerMD.modules.welding.Interface`, `flowerMD.modules.welding.WeldSimulation`,
and `flowerMD.library.simulations.Tensile`.

We can use these four blocks to build the following recipe:
1. `SlabSimulation` creates two "slabs" of e.g. polyethylene
2. `Interface` joins two resultant slabs at an interface
3. `WeldSimulation` simulates thermal welding at this interface, and
4. `Tensile` simulates a tensile test of the resultant weld to create a stress/strain curve.
Note that each of these steps can be run independently, and each simulation
type is agnostic to system and force field selection, enabling easy iteration with different
materials, force fields, etc. without replicating the workflow code itself.
materials, force fields, etc. without replicating the workflow code itself. One example might be
that we could instead run `SlabSimulation` on two different bulk polymers, then reuse the rest of
the recipe unchanged. We could also iterate over new weld temperatures pending results of `Tensile` runs, etc.
We hope this flexible and modular design will be a boon to many future molecular simulation researchers.
erjank marked this conversation as resolved.
Show resolved Hide resolved

marjanalbooyeh marked this conversation as resolved.
Show resolved Hide resolved
# Availability
`flowerMD` is freely available under the GNU General Public License (version 3)
Expand Down