peano4.api.output.Readme.Readme Class Reference

Creates one README for the whole setup, so people can look up what they have actually built. More...

Inheritance diagram for peano4.api.output.Readme.Readme:

Collaboration diagram for peano4.api.output.Readme.Readme:

Public Member Functions
	__init__ (self)
	add_package_description (self, readme_package_descriptor)
	set_constants (self, description)
	set_executable_name (self, executable_name)
	add_entry (self, readme_entry)
	generate (self, directory)
	Write README-executablename.md into directory, e.g.

Data Fields
	bibtex_entry

Protected Attributes
	_executable_name
	_package_descriptions
	_entries
	_constants

Private Attributes
	__Header

Static Private Attributes
str	__Header

Detailed Description

Creates one README for the whole setup, so people can look up what they have actually built.

The README has some default content. Then it hosts some info about the actual build. This information is provided from the makefile just before the readme is actually dumped. Finally, there is information about the individual tools used. This information is generated from peano4.api.datamodel.Model where each individual model that we use adds entries to the readme. Particular toolboxes or extensions can add their information through their models, too

Definition at line 10 of file Readme.py.

Constructor & Destructor Documentation

__init__()

peano4.api.output.Readme.Readme.__init__

(

self

)

Definition at line 96 of file Readme.py.

Member Function Documentation

add_entry()

peano4.api.output.Readme.Readme.add_entry	(		self,
			readme_entry
	)

Definition at line 113 of file Readme.py.

References peano4.api.output.Readme.Readme._entries.

add_package_description()

peano4.api.output.Readme.Readme.add_package_description	(		self,
			readme_package_descriptor
	)

Definition at line 103 of file Readme.py.

References peano4.api.output.Readme.Readme._package_descriptions.

generate()

peano4.api.output.Readme.Readme.generate	(		self,
			directory
	)

Write README-executablename.md into directory, e.g.

README-tsunami.md

If the project has no executable name, we fall back to the name of the Python script which invoked the generation.

Definition at line 117 of file Readme.py.

References exahype2.api.Project.Project._executable_name, exaparty.api.Project.Project._executable_name, api.Project.Project._executable_name, and peano4.api.output.Readme.Readme._executable_name.

Referenced by peano4.api.Project.Project.build().

Here is the caller graph for this function:

set_constants()

peano4.api.output.Readme.Readme.set_constants	(		self,
			description
	)

Definition at line 107 of file Readme.py.

References peano4.api.output.Readme.Readme._constants.

set_executable_name()

peano4.api.output.Readme.Readme.set_executable_name	(		self,
			executable_name
	)

Definition at line 110 of file Readme.py.

References exahype2.api.Project.Project._executable_name, exaparty.api.Project.Project._executable_name, api.Project.Project._executable_name, and peano4.api.output.Readme.Readme._executable_name.

Field Documentation

__Header [1/2]

str peano4.api.output.Readme.Readme.__Header

staticprivate

Definition at line 24 of file Readme.py.

__Header [2/2]

peano4.api.output.Readme.Readme.__Header

private

Definition at line 130 of file Readme.py.

_constants

peano4.api.output.Readme.Readme._constants

protected

Definition at line 101 of file Readme.py.

Referenced by peano4.api.output.Readme.Readme.set_constants().

_entries

peano4.api.output.Readme.Readme._entries

protected

Definition at line 100 of file Readme.py.

Referenced by peano4.api.output.Readme.Readme.add_entry().

_executable_name

peano4.api.output.Readme.Readme._executable_name

protected

Definition at line 98 of file Readme.py.

Referenced by exaparty.api.Project.Project.__configure_makefile(), api.Project.Project.__configure_makefile(), api.Project.Project.__init__(), peano4.api.output.Readme.Readme.generate(), and peano4.api.output.Readme.Readme.set_executable_name().

_package_descriptions

peano4.api.output.Readme.Readme._package_descriptions

protected

Definition at line 99 of file Readme.py.

Referenced by peano4.api.output.Readme.Readme.add_package_description().

bibtex_entry

peano4.api.output.Readme.Readme.bibtex_entry

Definition at line 97 of file Readme.py.

---

The documentation for this class was generated from the following file:

• src/peano4/api/output/Readme.py