github上科学论文的单一脚本?

时间:2015-09-05 11:07:38

标签: matlab github computer-science

我发布这个问题,尽管它可能是偏离主题的,因为我找不到更好的地方问:

我正在发表科学论文,并使用一些我希望公开发布的分析代码。我写了一个通用分析库(Matlab)并将它放到github上。然后有一个小脚本使用该库来实现本文的特定目的。发布该脚本的最佳方式是什么?

我看到以下选项发布此脚本的位置:

  1. 发布到一个新的存储库,只有一个文件在论文中被引用(这不是一个过度杀手吗?)
  2. 将分析脚本作为补充信息添加到论文中(对其他人来说不太容易访问和使用)
  3. 添加到与库相同的存储库(没有意义,因为该库是通用的,而脚本仅用于单个特定用途)
  4. 对任何反馈,重新指导或讨论感到高兴。

2 个答案:

答案 0 :(得分:3)

我不知道是否是最好的方法,但这是我用我自己的一个Matlab库SHCTools所做的,以便公开发表期刊文章:

  1. 创建了存储库的new branch(而不是全新的存储库)。这样两者是共存的,但特定于纸张的分支可以保持稳定,即使在主存储库发生显着变化之后,读者也可以复制结果。

  2. 在主分支的README.md文件中添加了一个通知,链接到新的稳定分支。

  3. 在新的稳定分支中添加了一个文件夹,其中包含可以在纸张中重新创建数字的M文件(您可以使用示例执行相同操作)。

答案 1 :(得分:1)

添加脚本作为补充资源(可能在examplescontrib目录中)似乎是一种可接受且合理的标准安排。

对于独立脚本,或许可以考虑将其发布为gist;这是Github的一个辅助服务,用于简单的独立代码片段。