Skip to content

Commit 0348dc4

Browse files
committed
Initial commit for JOSS paper notes
1 parent 0b617ad commit 0348dc4

File tree

3 files changed

+58
-0
lines changed

3 files changed

+58
-0
lines changed

docs/papers/joss/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.log
2+
3+
/paper.pdf

docs/papers/joss/paper.bib

Whitespace-only changes.

docs/papers/joss/paper.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: 'TBD: ClimaCore: the dycore library for CliMA's proposed ESM'
3+
tags:
4+
- earth system modeling
5+
- dycore
6+
- flexible discretizations
7+
- spectral elements
8+
- staggered finite differences
9+
- matrix-free
10+
authors:
11+
- name: Foo
12+
orcid: XXXX
13+
affiliation: 1
14+
- name: Bar
15+
orcid: YYYY
16+
affiliation: 2
17+
affiliations:
18+
- name: California Institute of Technology
19+
index: 1
20+
- name: Other Institution
21+
index: 2
22+
date: 10 January 2023
23+
bibliography: paper.bib
24+
---
25+
26+
# Motivation and Benefits
27+
A "white paper" that briefly mentions all the nice properties of the library: extensibility, composability, ease-of-use, library-reuse, (performance-portability?), (scalability?). This will give ClimaCore its proper DOI and citability tool.
28+
29+
# Costs
30+
From JOSS' [website](https://joss.readthedocs.io/en/latest/submitting.html#submitting-a-paper-to-joss): "If you’ve already developed a fully featured research code, released it under an OSI-approved license, and written good documentation and tests, then we expect that it should take perhaps an hour or two to prepare and submit your paper to JOSS. But please read these instructions carefully for a streamlined submission."
31+
32+
# Tentative TODOs
33+
Improve Docs:
34+
- [x] Getting started/How to guide
35+
- [x] Contributing guide + Authorship policy + Code of Conduct (?)
36+
- [ ] Examples documentation (equations set, what to expect from each example, artifacts, if included)
37+
38+
39+
Improve Unit Tests:
40+
- [ ] Unit tests: strive for best code coverage: e.g., double check that all operators are tested
41+
42+
43+
Performance:
44+
- [ ] Distributed computing capability (probably no need for scaling studies)
45+
- [ ] Multi-threading capability (might include initial GPU support?)
46+
47+
# Summary and statement of need
48+
49+
Lorem Ipsum
50+
51+
52+
# Acknowledgements
53+
54+
55+
# References

0 commit comments

Comments
 (0)