关于 github 的科学论文的单一脚本?
single script for scientific paper on github?
我发布了这个问题,尽管它可能是题外话,因为我找不到更好的地方来问:
我正在发表一篇科学论文并使用一些我希望公开的分析代码。我编写了一个通用分析库 (Matlab) 并将其放到 github 上。然后有一个小脚本使用该库来实现本文的特定目的。发布该脚本的最佳方式是什么?
我看到以下用于发布此脚本的选项:
- 发布到一个新的存储库,其中只有一个在论文中引用的文件(这不是太过分了吗?)
- 附加分析脚本作为论文的补充信息(对其他人来说不是很容易访问和使用)
- 添加到与库相同的存储库(没有意义,因为库是通用的,而脚本是用于单一特定目的)
对任何反馈、重定向或讨论感到高兴。
添加脚本作为补充资源(可能在 examples
或 contrib
目录中)似乎是一种可接受且合理的标准安排。
对于独立脚本,或许可以考虑将其发布为 gist;这是 Github 的辅助服务,用于简单的独立代码段。
我不知道这是否是最好的方法,但这是我对自己的一个 Matlab 库 SHCTools 所做的,以使其在一篇期刊文章中公开可用:
已创建 new branch 存储库(相对于全新的存储库)。通过这种方式,两者位于同一位置,但论文特定的分支可以保持稳定,即使在主存储库发生重大变化后,读者也可以复制结果。
在主分支的 README.md 文件中添加了链接到新稳定分支的通知。
向新的稳定分支添加了一个文件夹,其中包含重新创建 5 月论文中的图形的 M 文件(您可以对示例执行相同的操作)。
我发布了这个问题,尽管它可能是题外话,因为我找不到更好的地方来问:
我正在发表一篇科学论文并使用一些我希望公开的分析代码。我编写了一个通用分析库 (Matlab) 并将其放到 github 上。然后有一个小脚本使用该库来实现本文的特定目的。发布该脚本的最佳方式是什么?
我看到以下用于发布此脚本的选项:
- 发布到一个新的存储库,其中只有一个在论文中引用的文件(这不是太过分了吗?)
- 附加分析脚本作为论文的补充信息(对其他人来说不是很容易访问和使用)
- 添加到与库相同的存储库(没有意义,因为库是通用的,而脚本是用于单一特定目的)
对任何反馈、重定向或讨论感到高兴。
添加脚本作为补充资源(可能在 examples
或 contrib
目录中)似乎是一种可接受且合理的标准安排。
对于独立脚本,或许可以考虑将其发布为 gist;这是 Github 的辅助服务,用于简单的独立代码段。
我不知道这是否是最好的方法,但这是我对自己的一个 Matlab 库 SHCTools 所做的,以使其在一篇期刊文章中公开可用:
已创建 new branch 存储库(相对于全新的存储库)。通过这种方式,两者位于同一位置,但论文特定的分支可以保持稳定,即使在主存储库发生重大变化后,读者也可以复制结果。
在主分支的 README.md 文件中添加了链接到新稳定分支的通知。
向新的稳定分支添加了一个文件夹,其中包含重新创建 5 月论文中的图形的 M 文件(您可以对示例执行相同的操作)。