Closed rodluger closed 3 years ago
Ahh thank you!! Yeah, I've quickly learned most of the reasons the action fails is either (a) forgetting to import something or (b) forgetting the new command in the style.tex, like this issue! It's been pretty easy to use otherwise!
Although getting figures to run has been challenging. From the docs, it seems like the label of the figure + the script + the pdf name all need to be the same and the action should pass? Or am I missing something?
Cool.
The script doesn't need to have the same name as the PDF it generates. The important thing is that if the figure label is \label{fig:foo}
, then showyourwork expects that all the PDFs within that figure
environment are generated by a script called src/figures/foo.py
.
If you try this and it fails, post a link to the CI logs and I can help!
Unrelated to this, I see you have a bunch of unnecessary branches that were copied over from the template repo. Did you check "Copy all branches" when creating your repo? I should add a note in the docs saying that's not necessary.
One more thing I noticed: you should place the figure label inside the figure environment, but outside the caption (i.e., this won't work with showyourwork: https://github.com/afeinstein20/v1298tau_tess/blob/f5d479d7b28ce0eac42395a918d7dc0992264e01/src/ms.tex#L100) That may have caused some of your issues.
Yeah! I noticed that in the docs last night, and realized I only changed it for one of the figures. I've updated all figure labels now (in the most recent build) and it still failed 😠sorry this seems like such a basic issue
No problem! Thanks for bearing with me on this. It looks like you're using figure* environments, which I didn't add support for until yesterday. Can you do
pushd showyourwork
git fetch
git checkout v0.1.14
popd
and then commit & push your changes? That will update the workflow to the latest version, which should fix the error you're seeing.
Updated! But it didn't seem to help? https://github.com/afeinstein20/v1298tau_tess/actions/runs/1368267156
Ah, this time it's not my fault! https://github.com/afeinstein20/v1298tau_tess/runs/3964885830?check_suite_focus=true#step:3:1523
Add lightkurve
to your environment.yml
Huzzah!! So I need to manually update my environment.yml
? That is good to know! Thanks Rodrigo 🥳
Awesome! Yes, either manually, or have conda generate it: https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#sharing-an-environment
This time you need to change the path from static/transits.pdf
to figures/transits.pdf
: https://github.com/afeinstein20/v1298tau_tess/runs/3965758659?check_suite_focus=true#step:3:1493
Hey @rodluger do you have a citation for showyourwork!
and/or a statement we can add to our acknowledgements?
Not yet! I'm planning on actually writing an article about it, so eventually that's what should be cited. In the time being you can cite
@ARTICLE{2021arXiv211006271L,
author = {{Luger}, Rodrigo and {Bedell}, Megan and {Foreman-Mackey}, Daniel and {Crossfield}, Ian J.~M. and {Zhao}, Lily L. and {Hogg}, David W.},
title = "{Mapping stellar surfaces III: An Efficient, Scalable, and Open-Source Doppler Imaging Model}",
journal = {arXiv e-prints},
keywords = {Astrophysics - Solar and Stellar Astrophysics, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2021,
month = oct,
eid = {arXiv:2110.06271},
pages = {arXiv:2110.06271},
archivePrefix = {arXiv},
eprint = {2110.06271},
primaryClass = {astro-ph.SR},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021arXiv211006271L},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
which is the paper in which I first introduced showyourwork. Thanks!
https://github.com/afeinstein20/v1298tau_tess/runs/3955225597?check_suite_focus=true#step:3:1068
I'm working on making these builds easier to debug. Currently the helpful error messages always get buried!
Let me know if I can help with anything, btw. And please give me suggestions/feedback if you have any! Thx for using showyourwork!