添加工具或文献示例

本页内容

有用的贡献可能很小:识别已发布的模型、找到其代码、改进设置步骤或报告失败的运行。浏览器足以提供来源。遵循 共享标准.

目录记录#

可编辑的源是 tools.csv, papers.csv, 和 examples.csv。 ID 是由连字符分隔的稳定小写名称; ID 列表使用分号。保持工具的示例 ID 与示例的工具 ID 一致。

对于工具,记录其用途、官方来源和文档、源代码许可证、单独的运行时/数据/资产条款、源可用性以及实际检查的日期。不要将免费下载与开源等同起来,也不要将存储库的可用性描述为维护或执行证据。包括有用的场景工具和优化框架,同时准确识别它们的角色。

作为参考,请根据主要记录验证标题、作者、年份、出版物类型和 DOI。记录全文访问和实际检查的段落,与元数据验证分开。软件论文可以支持该工具的描述;应用程序演练需要可识别的模型、方法、方程、列表、基准或实验。

例如,添加一个指南,给出研究问题、确切的论文连接、代码/存档版本、环境、输入术语、命令或具体执行路线、预期输出文件和比较措施。解释与论文的差异。使用一种状态:

CSV 中的状态 所需证据
executed_adaptation 包含教学代码运行;保留参数、环境、输出和实际检查。这并不主张纸质复制。
upstream_instructions_checked 检查源文件和上游运行指令;执行仍在等待中。
access_pending 已找到引文或文章,但尚无法检查所需的工件。准确地说明缺少什么。

使用 运行记录模板 为了新的奔跑。声称已发表的结果被复制还需要指定的目标、匹配的方法和输入、明确的比较和容忍以及人类科学审查。将实质性的新研究保存在自己的研究库中。

完整目录的研究路线#

的 纸质到代码的路线清单 与接受的教学实例目录分开记录施工计划。编辑 research/routes.json 并保留主要元数据记录、论文位置、代码与论文关系、可用的不可变版本、输入访问、构建命令、比较目标、执行证据和未解决的差距。

论文结果候选者确定要重现的内容;软件论文示例或相关教程与研究的关系较窄。请勿升级没有运行记录的执行状态。已发布的目标比较需要匹配的输入和方法、明确的可观察值和公差以及保留的数字证据。人类科学审查仍然是分开的。

运行 python3 simulation-lab/research.py --write 在重新生成主目录之前。这将验证每个目录工具的一条路线,并生成六个域指南和可下载的路线清单。新的实质性研究属于研究存储库;该清单是共享学习和复制计划。

作者代码尝试和数值比较#

的 候选人竞选活动 21 个选定工具中的每一个都有一条记录。保留原始故障、出版物/文档版本、匹配的输入设置、本机输出和哈希值以及对代码或环境的任何更改。作者代码运行、维护的第三方复制、改编、档案分析和通过的选定论文比较具有不同的证据要求。

在产生数值结果之前声明可观察和比较规则。即使随后进行确定性重新运行,修改后的提取或事后比较仍然是探索性的。纸质目标需要源位置和合理的精度或不确定性;当前的固定装置或存档输出匹配必须保留较窄的范围。与进程退出状态分开检查求解器收敛性和可行性。将人类科学审查记录为待定,直到实际执行为止。

编辑 reproductions/campaign.json 及其原始指南模板,然后重新生成 python3 simulation-lab/reproduce.py --write。仅共享明确可重用的输出并保留每个文件的资产、模型和运行时术语。新的成功范例使用 executed_author_code 或者,对于通过的选定目标及其证据, published_target_compared。保存的输出分析使用 analysed_saved_output。这些状态从来不主张整篇论文的复制或人类的接受。

重新生成并检查#

从 hub 根目录,使用 Python 3.10 或更高版本:

python3 simulation-lab/reproduce.py --write
python3 simulation-lab/research.py --write
python3 simulation-lab/catalog.py --write
python3 simulation-lab/catalog.py

这会检查标识符、引用、日期、源链接格式、本地指南文件和生成文件的新鲜度。它不联系外部网站或验证科学主张。遵循 网站建设说明 更改页面时检查呈现的链接和布局。

提交拉取请求,其中包含您检查的来源、您运行的命令、结果、剩余限制、材料代理协助和负责人。除非再分发条款允许,否则请勿上传库 PDF。一个 DOI 和精确的通道位置足以引用受限文章;使用 资源请求路由 当需要访问时。

查看 GitHub 上的源代码