search

mesh-adaptation / animate

Anisotropic mesh adaptation toolkit for Firedrake
MIT License
5 stars 0 forks source link

Add `CITATION.cff` #128

Closed jwallwork23 closed 1 month ago

jwallwork23 commented 1 month ago

Closes #127. Closes #86. Closes #126.

Adds a citation file so that releases work nicely with Zenodo.

Reviewers: please check you are happy with how your names are presented, that your ORCIDs are correct and present (if you have one). Feel free to push directly to the branch if you have edits.

jwallwork23 commented 1 month ago

Also pushed minor changes to label all TODOs with issues. Ready for review.

jwallwork23 commented 1 month ago

Also fix for #126.

ddundo commented 1 month ago

Thanks @jwallwork23! I added my ORCID and pushed it here since you said we could :)

I also thought I'd add the other missing plot in the ping-pong demo (ping_pong-source_function.jpg) since it's a minor change, but then saw that in some parts of the demo you refer to it as a source function and in other as a sensor function. So the title of these plots is different in ping_pong-source_function.jpg and in ping_pong-final.jpg, even though they're the same function. Maybe choose one for consistency?

ddundo commented 1 month ago

Also, initially I didn't have cffconvert installed so I got this error:

Checking CITATION.cff formatting...
make: cffconvert: No such file or directory
make: *** [Makefile:32: check_citation] Error 127

but this message got lost in all the other messages that make test prints out, since everything proceeded as normal.

Can we make it so that make test breaks if an error occurs here, so that we can easily catch it? This is what happens if there is an error in the lint part of testing, for example.

Edit: sorry, ignore me... this is all good.

jwallwork23 commented 1 month ago

I also thought I'd add the other missing plot in the ping-pong demo (ping_pong-source_function.jpg) since it's a minor change, but then saw that in some parts of the demo you refer to it as a source function and in other as a sensor function. So the title of these plots is different in ping_pong-source_function.jpg and in ping_pong-final.jpg, even though they're the same function. Maybe choose one for consistency?

@ddundo Thanks, fixed by 6aedaf3885fec6f08d2a7bfeb455398cd7418451.

jwallwork23 commented 1 month ago

@acse-ej321 do you have an ORCID to add or can we merge this?