search

mesh-adaptation / goalie

Goal-oriented error estimation and mesh adaptation for finite element problems solved using Firedrake
Other
1 stars 1 forks source link

Citing goalie and animate #115

Closed ddundo closed 1 month ago

ddundo commented 4 months ago

Currently relevant for me. Could we add a CITATION file for goalie and animate?

jwallwork23 commented 4 months ago

When do you need the citations by? I wonder it would be possible to archive the Animate and Goalie versions as part of a Firedrake Zenodo release. If not, we could make bespoke ones - I've done that in the past for Pyroteus.

ddundo commented 4 months ago

Thanks Joe, probably in the next 1-2 months latest, so not too urgent :)

jwallwork23 commented 4 months ago

Okay great, I'll plan to figure out a process for this next week.

jwallwork23 commented 4 months ago

@ddundo Okay I think I have things set up. You can create a Zenodo release for each package. Follow the instructions here but for Animate and Goalie: https://github.com/thetisproject/thetis/wiki/Instructions:-Thetis-Zenodo-release

Let me know how it goes and if it works then we can close this issue.

jwallwork23 commented 3 months ago

@ddundo What do you think of this new page? https://github.com/mesh-adaptation/mesh-adaptation-docs/wiki/Citing

Are the instructions sufficiently clear?

jwallwork23 commented 3 months ago

Note that so far there's only an example for Movement.

ddundo commented 3 months ago

Thanks @jwallwork23, looks good to me! Although if I may nitpick, instead of "add some text" I might prefer "add a title and description" :)

I haven't tried it out yet but I can try it today if you'd like to close the issue - and then we can delete the release I make.

jwallwork23 commented 3 months ago

Thanks @jwallwork23, looks good to me! Although if I may nitpick, instead of "add some text" I might prefer "add a title and description" :)

Thanks, have done that.

I haven't tried it out yet but I can try it today if you'd like to close the issue - and then we can delete the release I make.

I'll wait until you've created your release before closing the issue. No rush, though. Note that even if you delete the release I have a feeling the Zenodo archive will persist, so if you are just doing this for testing purposes, maybe just create releases of the main branches of Animate and Goalie that we can refer to as Version 0.2, or something? (And don't delete them.)

jwallwork23 commented 2 months ago

Hm it turns out we probably should add a CITATION.cff file. (See https://github.com/mesh-adaptation/movement/issues/90.) Will do that now.