SuperAPI AI 工具集

open-science-reproducibility

写作与研究

查看项目

更新于 10-15 10:48

技能介绍

用途

本技能是一份面向 AEC(建筑、工程与建造)研究的开放科学与可复现性实践指南。其核心立场是:可复现性是可信度的倍增器,并且日益成为资助方与期刊的硬性要求。AEC 研究高度依赖模拟、定制数据集和专有工具,这使得可复现性尤为重要,却常常被忽视。本指南用于指导研究者在项目全周期中落实开放科学实践。

主要能力

1. FAIR 数据原则

  • 可发现(Findable):存入带持久标识符(DOI)和丰富元数据的仓储,并使其可被索引。
  • 可访问(Accessible):可通过标准协议检索;明确说明访问条件(开放还是受控)。
  • 可互操作(Interoperable):使用标准格式与词表(开放格式、有文档的模式;建成环境数据可考虑 IFC、CityGML、标准 CSV 加数据字典)。
  • 可复用(Reusable):清晰的许可、来源信息,以及足以正确复用的文档。

指南特别指出:FAIR 不等于“开放”。敏感或专有数据(场地、个人、商业数据)可以做到 FAIR,同时保持访问受控。

2. 数据仓储

  • 通用仓储:Zenodo(CERN;提供 DOI,支持 GitHub 集成)、Figshare、Dryad、OSF、Harvard Dataverse。
  • 机构仓储;以及存在时的领域仓储。
  • 选择标准:能发放 DOI、支持你的许可、提供版本管理。指南提醒避免仅以“可应要求提供”的方式共享数据——通常实际上并不会提供。

3. 数据管理计划(DMP)

应尽早规划(许多资助方要求在提案阶段提交)。需覆盖:收集/生成哪些数据;格式与体量;元数据与文档标准;项目期间的存储、备份与安全;法律/伦理约束(知情同意、GDPR、知识产权、保密);将共享什么、何时、何地、以何种许可;长期保存;以及角色与职责。可用工具:DMPonline / DMPTool / Argos。

4. 计算可复现性(代码与分析)

  • 一切纳入版本控制(Git);为论文所用版本打上确切的 commit/release 标签。
  • 捕获运行环境:requirements.txt/environment.yml(conda)、renv(R)、lockfile;或用 Docker/Apptainer 容器或 Binder 实现一键复现。
  • 文学化分析:使用 Jupyter、Quarto/R Markdown,使结果、图表可由数据重新生成。
  • 固定工具、库、求解器以及(能源类工作)气象文件的版本——结果会随版本变化。
  • 提供 README,写明确切运行步骤,并给出脚本到论文图表的映射。
  • 将代码发布归档并配 DOI(Zenodo–GitHub 集成),并加以引用。

5. 模拟/建模研究的可复现性(AEC 关键)

在知识产权允许的前提下共享模型输入文件(如 EnergyPlus IDF + EPW、OpenSees/FEM 输入、Grasshopper 定义);记录所有假设、边界条件和求解器设置。报告针对实测数据的校准/验证以及不确定性/敏感性分析——无法复现或验证的模型不可信。

6. 预印本、预注册与注册报告

  • 预印本:engrXiv、arXiv(部分 EESS/CS)、SSRN、OSF Preprints——确立优先权并开放获取;先查看目标期刊的预印本政策。
  • 预注册:在数据收集前登记假设、设计与分析计划(OSF、AsPredicted),以抑制验证性研究中的 HARKing/p-hacking。
  • 注册报告:在结果产生前对方案进行同行评审;原则上接受可减少发表偏倚。在工程类期刊中逐渐增多。

7. 开放获取

Gold/Green/Diamond/Hybrid OA;即使以封闭方式发表,也将接收稿存入仓储(Green)。遵守资助方/Plan S 要求;利用可用的转换性协议。

8. 数据与代码可用性声明(现已成为标准)

需写出明确声明,例如:

“The data and analysis code supporting this study are openly available in Zenodo at , under .”

“Restricted data: the building-monitoring dataset cannot be shared publicly due to a confidentiality agreement with the building owner; aggregated data are available from the corresponding author on reasonable request.”

指南强调:陈述事实——不要承诺你不会兑现的共享。

9. 署名与许可

明确为数据(如 CC BY)和代码(如 MIT/Apache-2.0/BSD,或按要求使用 GPL)设定许可。添加 CITATION.cff,以便他人正确引用你的软件/数据;引用你使用的数据集与工具。按所在期刊政策披露 AI 工具使用情况。

10. 与诚信的关联

可复现性是一种诚信实践:它让他人能够验证,而不仅仅是信任。绝不要把不可复现的工作流说成可复现的,也绝不要以违反知情同意、GDPR、知识产权或保密要求的方式共享数据。

使用方式

本技能以实践指南形式提供,按上述主题分节组织。使用者可将其作为项目规划与执行时的检查清单与参考,在数据管理、代码归档、论文投稿与声明撰写等环节逐项对照落实。资料未提供具体的安装命令或代码示例。

适用场景

适用于 AEC 领域的研究者、工程与建筑科研团队,以及需要满足资助方或期刊开放科学与可复现性要求的人员;也适用于涉及模拟/建模、定制数据集、专有工具的研究项目。

限制

资料未提供本技能的具体平台支持、收费方式、价格或效果数据;相关内容暂未提供。