Realization of best practices in software engineering and scientific writing through ready-to-use project skeletons

Author:

Haider MichaelORCID,Riesch MichaelORCID,Jirauschek ChristianORCID

Abstract

AbstractEfforts in providing high-quality scientific software are hardly rewarded, as scientific output is typically measured in terms of publications in high ranking journals. As a result, scientific software is often developed without proper documentation and support of modern software design patterns. Ready-to-use project skeletons can be employed to accelerate the development process, while at the same time taking care of the implementation of best practices in software engineering. In this work, we revisit best practices in software engineering and review existing project skeletons. Special emphasis is given on the realization of best practices. Finally, we present a new project skeleton for scientific writing in "Image missing", which takes care of the attainment of best practices, adapted for being used in academic publications.

Funder

Technische Universität München

Publisher

Springer Science and Business Media LLC

Subject

Electrical and Electronic Engineering,Atomic and Molecular Physics, and Optics,Electronic, Optical and Magnetic Materials

Reference33 articles.

1. Bangerth, W., Heister, T.: What makes computational open source software libraries successful? Comput. Sci. Disc. 6, 015010 (2013). https://doi.org/10.1088/1749-4699/6/1/015010

2. Carré, J.B.: MathWorks MATLAB project template. https://github.com/speredenn/matlab-project-template (2012)

3. conda-forge: Conda feedstock for bertha. https://github.com/conda-forge/bertha-feedstock (2019)

4. GitLab Inc: Introduction to GitLab Flow. https://docs.gitlab.com/ee/topics/gitlab_flow.html (2020)

5. Haider, M., Riesch, M., Jirauschek, C.: bertha-tex: Project skeleton for scientific writing in LaTeX. https://gitlab.com/cph-tum/bertha-tex (2020)

Cited by 2 articles. 订阅此论文施引文献 订阅此论文施引文献,注册后可以免费订阅5篇论文的施引文献,订阅后可以查看论文全部施引文献

1. Towards Evidence-Based Software Quality Practices for Reproducibility: Practices and Aligned Software Qualities;Proceedings of the 2nd ACM Conference on Reproducibility and Replicability;2024-06-18

2. Research on Nomenclature of Scientific Software Variables in Communication Field;2022 IEEE 10th International Conference on Information, Communication and Networks (ICICN);2022-08-23

同舟云学术

1.学者识别学者识别

2.学术分析学术分析

3.人才评估人才评估

"同舟云学术"是以全球学者为主线,采集、加工和组织学术论文而形成的新型学术文献查询和分析系统,可以对全球学者进行文献检索和人才价值评估。用户可以通过关注某些学科领域的顶尖人物而持续追踪该领域的学科进展和研究前沿。经过近期的数据扩容,当前同舟云学术共收录了国内外主流学术期刊6万余种,收集的期刊论文及会议论文总量共计约1.5亿篇,并以每天添加12000余篇中外论文的速度递增。我们也可以为用户提供个性化、定制化的学者数据。欢迎来电咨询!咨询电话:010-8811{复制后删除}0370

www.globalauthorid.com

TOP

Copyright © 2019-2024 北京同舟云网络信息技术有限公司
京公网安备11010802033243号  京ICP备18003416号-3