Closed nickross4444 closed 1 year ago
A couple of thoughts/responses:
Did I cover everything?
@ryancoe For now I can use github links as our upload repository, but I don't believe that will work for the final HardwareX submission. I found this at this site linked from the guide to authors:
"Other repositories (e.g. GitHub, Google Drive, etc.) are not permitted because they can be modified post-publication. This policy ensures the longevity of HardwareX articles."
Perhaps I can put github links for the draft versions and switch to an approved repository for the final draft?
@ryancoe
Thanks for digging into this @nickross4444. Please take a look at this page about integrating Zenodo w. Github. I haven't done this before, but others in our group have (maybe @ssolson?). If I understand it correctly, this will create a DOI pointing to specific commit in our repo.
Mostly finished in 663d029da2039ec0f449b3e0388ad48e68e9e34b. Decided to reference "online repository" instead of linking to each file, as other HardwareX papers have done. Now just waiting for the CAD model.
As a note, the course of action for finalizing the link to the repo in the paper will be as follows:
@nickross4444 - please give status update here
Once issues #3, #85, #102 are complete, we can create the new branch that will get uploaded to Zenodo and finalize the paper from there.
Minor detail, but I think the key step with Zenodo is to tag a release (https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content), not make a specific branch. Are you looking at something different?
As detailed here, we'll need to create a release branch first, not only for gitflow but also to get rid of the paper itself and any other redundant documents from the release.
@ryancoe I've created the branch for the release and the release, but in order to get it on zenodo with git integration, whoever owns the repo needs to log into zenodo through their github account. I think you should be able to do it in a couple minutes, but I am unable to.
Ok, I think I did it: https://zenodo.org/record/7502670. Please close this issue if you agree.
@ryancoe I think it's missing the CAD files and the educational material. Besides that good to go.
This had me scratching my head for a bit, but the files are actually there. The Zenodo website preview does not include all files.
When I download the .zip
file from Zenodo, I do indeed see the CAD files.
Okay, interesting. I'll get everything else wrapped up soon then.
These are the instructions for design files in the paper:
The complete design files must be either uploaded to an approved online repository, uploaded at the time of submission on the online Elsevier submission interface as supplementary materials [CAD files, videos,. . . ], or included in the body of the manuscript [e.g. figures]. The two approved online repositories are Mendeley Data and the Open Science Framework [OSF instructions]. Mendeley data: https://data.mendeley.com/ Open Science Framework: https://osf.io/ Open Science Frame- work HardwareX instructions: https://osf.io/wgk7q/wiki/home/
My thought is we include the following files: -Arduino sketches -Processing sketches -Tank CAD model. @Anwi505 is going to try adding the Plunger and WEC hardware to the current model. We might also be able to upload pictures as design files, but I'm not sure about that. -Plunger CAD model (maybe included in tank CAD model) -MiniWEC buoy dimensions or CAD(maybe included in tank CAD model)
I found these dimensions for an old buoy, but I'm not sure what the new values would be. @ryancoe, do you have any guidance for this? (new values, and would a diagram like above be better or a CAD model?)
On another note the guidance states that "All designs must be submitted under an open hardware license." I believe we've done this for the sketches, but I don't think we have for any of the CAD models. @ryancoe, how should I move forward with this, and what do I list in the paper when it asks to fill in the license?
Current CAD model: