carputils
Doxygen code documentation for the python framework controlling openCARP
Functions
bin.generateMetadata Namespace Reference

Create a copy of the metadata template for experiments. More...

Functions

def generate_metadata_file (location='.', metadata_filename='codemeta.json')
 Copy the metadata template in the location directory. More...
 
def main (argv)
 Copy the metadata template at the location provided in argv[1], or in the current working directory if argv contains less than 2 elements. More...
 

Detailed Description

Create a copy of the metadata template for experiments.

Copy the metadata template for experiments in the location provided as a command-line argument, with the name codemeta.json. If no argument is given, the template is copied in the current working directory.

Example of usage:

./generateMetadata /path/to/experiment

This creates the file /path/to/experiment/codemeta.json, if /path/to/experiment is the path to an existing directory.

Function Documentation

◆ generate_metadata_file()

def bin.generateMetadata.generate_metadata_file (   location = '.',
  metadata_filename = 'codemeta.json' 
)

Copy the metadata template in the location directory.

◆ main()

def bin.generateMetadata.main (   argv)

Copy the metadata template at the location provided in argv[1], or in the current working directory if argv contains less than 2 elements.