Portal/TA1/guidelines/authors

From MaRDI portal
Revision as of 11:19, 1 June 2022 by LKastner (talk | contribs) (T1: First rough sketch of computer experiment guidelines)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Guidelines for authors of computer experiments in computer algebra

This is still work in progress, so the information may be incomplete. Feedback is very welcome.

Environment

This section contains pointers what needs to be recorded for other people to be able to understand and reproduce the experiment.

Hardware

  • Type of machine if applicable
  • CPU information
  • Memory information

Software

  • Operating system with version
  • Software used with version

Experiment details

  • Collect all your code
  • Make sure your code is easy to read, adhering to the principles of clean code is a good idea
  • It may take some time for a reader to understand your code. It should not take time to make it run. Provide a central script that reruns your experiment.
  • Provide any in- and output data from your experiment. If it is large consider uploading it to a service like zenodo.
  • If your environment is complicated to set up, consider providing a Docker container or a Vagrant virtual machine.