reference_manager Module Reference

provides a uniform framework to add references to CP2K cite and output these More...

Functions/Subroutines
subroutine, public	cite_reference (key)
	marks a given reference as cited. More...
subroutine, public	collect_citations_from_ranks (para_env)
	Checks for each reference if any mpi-rank has marked it for citation. More...
subroutine, public	add_reference (key, ISI_record, DOI)
	add a reference to the bibliography More...
subroutine, public	remove_all_references ()
	deallocate the bibliography More...
subroutine, public	print_all_references (cited_only, sorted, FORMAT, unit, list)
	printout of all references in a specific format optionally printing only those that are actually cited during program execution More...
subroutine, public	print_reference (key, FORMAT, unit)
	printout of a specified reference to a given unit in a selectable format More...
pure character(len=default_string_length) function, public	get_citation_key (key)
	... More...

Variables
integer, parameter, public	print_format_isi = 101
integer, parameter, public	print_format_journal = 102
integer, parameter, public	print_format_html = 103

Detailed Description

provides a uniform framework to add references to CP2K cite and output these

Note

references need to be input using the ISI citation format, because it is uniform, easy to parse, and can be exported for example from web of science furthermore, it can be easily converted to and from using the bibutils tools a collection of easy to use conversion programs that can be found at http://www.scripps.edu/~cdputnam/software/bibutils/ by Chris Putnam

see thebibliography.F on how to add references easily

History

08.2007 [Joost VandeVondele]

Author

Joost VandeVondele

Function/Subroutine Documentation

cite_reference()

subroutine, public reference_manager::cite_reference

(

integer, intent(in)

key

)

marks a given reference as cited.

Parameters

key	citation key as returned from add_reference

History

XX.2007 created [ ]

Definition at line 87 of file reference_manager.F.

Here is the caller graph for this function:

collect_citations_from_ranks()

subroutine, public reference_manager::collect_citations_from_ranks

(

type(mp_para_env_type), intent(in)

para_env

)

Checks for each reference if any mpi-rank has marked it for citation.

Parameters

para_env

...

History

12.2013 created [Ole Schuett]

Definition at line 103 of file reference_manager.F.

Here is the caller graph for this function:

add_reference()

subroutine, public reference_manager::add_reference	(	integer, intent(out)	key,
		character(len=*), dimension(:), intent(in)	ISI_record,
		character(len=*), intent(in)	DOI
	)

add a reference to the bibliography

Parameters

key	output, this handle is needed to cite this reference later
ISI_record	...
DOI	...

History

08.2007 created [Joost VandeVondele]

Note

• see bibliography.F for it use.
• the ISI record is space sensitive, in particular the first three characters need to be blank or contain a key indicating the record type. See the header of this file for tools that can convert e.g. bibtex or endnote files to the ISI format
• DOI: provide the DOI without a link. The link will be automatically created as needed.

Definition at line 131 of file reference_manager.F.

Here is the call graph for this function:

Here is the caller graph for this function:

remove_all_references()

subroutine, public reference_manager::remove_all_references

deallocate the bibliography

History

08.2007 Joost VandeVondele [ ]

Definition at line 204 of file reference_manager.F.

Here is the caller graph for this function:

print_all_references()

subroutine, public reference_manager::print_all_references	(	logical, intent(in)	cited_only,
		logical, intent(in)	sorted,
		integer, intent(in)	FORMAT,
		integer, intent(in)	unit,
		integer, dimension(:), intent(in), optional	list
	)

printout of all references in a specific format optionally printing only those that are actually cited during program execution

Parameters

cited_only	print only those marked as cited
sorted	sort entries most recent first according to the date, otherways sort with respect to key
FORMAT	see module parameters print_format_XXXXXXXXX
unit	...
list	optionally, output a sub-list only

History

08.2007 Joost VandeVondele [ ]

Definition at line 229 of file reference_manager.F.

Here is the call graph for this function:

Here is the caller graph for this function:

print_reference()

subroutine, public reference_manager::print_reference	(	integer, intent(in)	key,
		integer, intent(in)	FORMAT,
		integer, intent(in)	unit
	)

printout of a specified reference to a given unit in a selectable format

Parameters

key	as returned from add_reference
FORMAT	see module parameters print_format_XXXXXXXXX
unit	...

History

08.2007 Joost VandeVondele [ ]

Definition at line 323 of file reference_manager.F.

Here is the caller graph for this function:

get_citation_key()

pure character(len=default_string_length) function, public reference_manager::get_citation_key

(

integer, intent(in)

key

)

...

Parameters

key

...

Returns

...

Definition at line 732 of file reference_manager.F.

Here is the caller graph for this function:

Variable Documentation

print_format_isi

integer, parameter, public reference_manager::print_format_isi = 101

Definition at line 36 of file reference_manager.F.

print_format_journal

integer, parameter, public reference_manager::print_format_journal = 102

Definition at line 36 of file reference_manager.F.

print_format_html

integer, parameter, public reference_manager::print_format_html = 103

Definition at line 36 of file reference_manager.F.