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

Make stellopt suite available as Linux packages #77

Open
jonathanschilling opened this issue Jul 17, 2020 · 5 comments
Open

Make stellopt suite available as Linux packages #77

jonathanschilling opened this issue Jul 17, 2020 · 5 comments
Labels
question Further information is requested

Comments

@jonathanschilling
Copy link
Collaborator

As far as I understood, the code in this repo is open source now, correct? What are your opinions about spreading compiled versions into the most popular Linux distributions, e.g. Debian/Ubuntu, Arch Linux, ... and MacPorts/homebrew? Are there any licensing or other restrictions?
I think this would allow to clean up the build scripts a little bit, since not every user would have to create their own entries, but one would rather have

  • some entries for the common distributions and
  • the entries for all the supercomputers.

Wouldn't it be fun to be able to do apt-get install vmec? ;-)

@smiet
Copy link
Collaborator

smiet commented Jul 17, 2020

I would love this! I can work on getting an AUR (Arch User Repository) package up and running.

For Arch I don't think we would need a compiled version, a suitable PKGBUILD that clones the repo and puts the binaries in the correct places would do the trick.

@jonathanschilling
Copy link
Collaborator Author

@zhucaoxiang
I was browsing through the GitHub guides and saw that it should be relatively easy to assign a DOI to a STELLOPT release, since the code is open source: https://guides.github.com/activities/citable-code/
Probably this is redundant with citing the original article; what do you think?

@zhucaoxiang
Copy link
Collaborator

zhucaoxiang commented Sep 24, 2020 via email

@lazersos
Copy link
Collaborator

@jonathanschilling, @zhucaoxiang, here's the BibTeX for the code citation. We should use this whenever referencing the code itself. However, when referencing a specific result we should cite the paper published on that subject.

@misc{ doecode_12551,
title = {STELLOPT},
author = {Lazerson, Samuel and Schmitt, John and Zhu, Caoxiang and Breslau, Joshua and STELLOPT Developers, All},
abstractNote = {The STELLOPT code is designed to optimize 3D MHD equilibria to a set of target physics parameters encompassing stellarator design and 3D equilibrium reconstructions.},
url = {https://doi.org/10.11578/dc.20180627.6},
howpublished = {[Computer Software] \url{https://doi.org/10.11578/dc.20180627.6}},
year = {2020},
month = {may}
}

@jonathanschilling
Copy link
Collaborator Author

@lazersos Ok, thanks for the info :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

7 participants