code-ini

Code Meta-Data for research software, scientific computing and computer-based experiments.

This is a curated list of research software projects providing code meta data, proposed in "JSON-LD for software discovery, reuse and credit", which facilitates replicability, reproducibility and reusability (RRR).

Using an ini-file named CODE was suggested in:

J. Heiland, J. Fehr, C. Himpe and J. Saak. Best Practices for Replicability, Reproducibility and Reusability of Computer-Based Experiments Exemplified by Model Reduction Software. AIMS Mathematics (AIMS Math) 1(3): 261--281, 2016. doi:10.3934/Math.2016.3.261

An additional benefit is the visibility and discoverability of scientific source codes. Add yours!

Sample Keys

name: project name
shortname: executable or abbreviated project name
version: project version number: major.minor.patch
release-date: version release date in ISO 8601 format: yyyy-mm-dd
id: project version identifier
id-type: identifier type, i.e.: doi
author: comma separated list of author names
orcid: comma separated list of author ORCIDs
topic: dmoz.org categorization of project
type: project type, i.e.: application, library, toolbox
license: opensource.org name of project license
license-type: license classification, i.e.: open, copy-left
repository: url of project repository
repository-type: repository protocol, i.e.: git
language: comma separated list of utilized programming languages
dependencies: comma separated list of dependencies with versions, ie: Octave >=4.2, Matlab >=2016b
systems: comma separated list of compatible operating systems, i.e.: Windows, Linux
website: url of project website
keywords: comma separated list of (up to five) keywords

Field Values

It is recommended to use only printable ASCII characters.

Declaration Header

Optionally, a code-ini declaration may be included as a first line:

# code.ini

File Format

Use a plain text, UTF-8 encoded file.

Research Software Projects:

• c-mess C Matrix Equations Sparse Solvers [code.ini]
• emgr EMpirical GRamian Framework [code.ini]
• flexiblas FlexiBLAS - A runtime BLAS switch [code.ini]
• granso GRadient-based Algorithm for Non-Smooth Optimization [code.ini]
• hapod HAPOD - Hierarchical Approximate Proper Orthogonal Decomposition [code.ini]
• morlab Model Order Reduction LABoratory
• m-mess MATLAB Matrix Equations Sparse Solvers [code.ini]
• morgen morgen - Model Order Reduction for Gas and Energy Networks [code.ini]
• qrupdate-ng A FORTRAN library for rank-1 matrix decomposition updates [code.ini]
• rostapack RObust STAbility PACKage [code.ini]
• solbt Limited Balanced Truncation for Large-Scale Sparse Second-Order Systems
• somddpa Second-Order Modally-Damped Dominant Pole Algorithm

Get the Shield Badge:

![code meta-data shield](https://img.shields.io/badge/code_meta--data-%E2%9C%93-brightgreen.svg)

Automatized CODE check is planned.

See Also:

• codemeta
• setup.py
• .desktop
• gem spec