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

docs: paper edits #153

Merged
merged 11 commits into from
Jul 7, 2022
Merged

docs: paper edits #153

merged 11 commits into from
Jul 7, 2022

Conversation

kjappelbaum
Copy link
Contributor

@kjappelbaum kjappelbaum commented Jul 7, 2022

First, thanks for adding me to the author list. I'm happy to be on it, but only if you consider my contributions worth it.

I went through your paper draft and performed some changes. I tried to do small commits, such that one can cherry-pick/drop some. (My commit prefixes docs are because I'm used to conventional commits.)

I'm not a native speaker though - therefore, some edits might make it worse.

Note: I'm still trying to fix the non-compilation issue (https://whedon.theoj.org/preview):

Looks like we failed to compile the PDF with the following error: Error producing PDF. ! Argument of \caption@ydblarg has an extra }. \par l.460 ...lizations}. \label{fig:original-decoded}}

@sgbaird
Copy link
Member

sgbaird commented Jul 7, 2022

@kjappelbaum thanks for this! I've appreciated the insights, involvement, and code contributions you've made. I'm not sure why it wasn't compiling on the site you mentioned, but the draft-pdf CI workflow seems to have gone OK. https://github.com/sparks-baird/xtal2png/actions/runs/2631558919

- drop grayscale
- material informatics --> materials informatics (https://en.wikipedia.org/wiki/Materials_informatics)
- mention the "multiple discovery" (really "multiple domain transfer") of Roost and CrabNet, i.e. sometimes the multiple year periods of domain transfer can result in significant overlapping work among multiple research groups
- correlates --> corresponding applications
@sgbaird
Copy link
Member

sgbaird commented Jul 7, 2022

Feel free to take another pass if you'd like to look at the touch-ups I made, otherwise will merge. Thanks again for going through this!

@kjappelbaum
Copy link
Contributor Author

I'm not sure why it wasn't compiling on the site you mentioned, but the draft-pdf CI workflow seems to have gone OK. https://github.com/sparks-baird/xtal2png/actions/runs/2631558919

also didn't understand this - used this in the past to get the PDF without re-triggering actions.

Thanks also for the touchups!

@sgbaird
Copy link
Member

sgbaird commented Jul 7, 2022

also didn't understand this - used this in the past to get the PDF without re-triggering actions.

Ah, gotcha. Just not sure why it's working for the CI but not the site you linked.

![(a) Original and (b) `xtal2png` decoded visualizations of
[`mp-560471`](https://materialsproject.org/materials/mp-560471/) / $Zn_2B_2PbO_6$.
Images were generated using [ase
visualizations](https://wiki.fysik.dtu.dk/ase/ase/visualize/visualize.html).
\label{fig:original-decoded}](figures/original-decoded.png){ width=50% }

The usage here seemed fine to me based on what's shown in the docs:

Figures can be included like this:
![Caption for example figure.\label{fig:example}](figure.png)
and referenced from text using \autoref{fig:example}.

@sgbaird sgbaird merged commit 34cb974 into sparks-baird:main Jul 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants