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.
subroutine, public	collect_citations_from_ranks (para_env)
	Checks for each reference if any mpi-rank has marked it for citation.
subroutine, public	add_reference (key, authors, title, source, volume, pages, year, doi)
	add a reference to the bibliography
subroutine, public	remove_all_references ()
	deallocate the bibliography
subroutine, public	print_cited_references (unit)
	printout of all cited references in the journal format sorted by publication year
subroutine, public	export_references_as_xml (unit)
	Exports all references as XML.
pure character(len=default_string_length) function, public	get_citation_key (key)
	...

Variables
integer, save	nbib = 0

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] 07.2024 [Ole Schuett]

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 84 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 100 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)	authors,
		character(len=*), intent(in)	title,
		character(len=*), intent(in)	source,
		character(len=*), intent(in), optional	volume,
		character(len=*), intent(in), optional	pages,
		integer, intent(in)	year,
		character(len=*), intent(in), optional	doi
	)

add a reference to the bibliography

Parameters

key	output, this handle is needed to cite this reference later
authors	...
title	...
source	...
volume	...
pages	...
year	...
doi	...

History

08.2007 created [Joost VandeVondele] 07.2024 complete rewrite [Ole Schuett]

Note

• see bibliography.F for it use.

Definition at line 130 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 213 of file reference_manager.F.

Here is the caller graph for this function:

print_cited_references()

subroutine, public reference_manager::print_cited_references

(

integer, intent(in)

unit

)

printout of all cited references in the journal format sorted by publication year

Parameters

unit

...

History

08.2007 Joost VandeVondele 07.2024 Ole Schuett

Definition at line 228 of file reference_manager.F.

Here is the call graph for this function:

Here is the caller graph for this function:

export_references_as_xml()

subroutine, public reference_manager::export_references_as_xml

(

integer, intent(in)

unit

)

Exports all references as XML.

Parameters

unit

...

Author

Ole Schuett

Definition at line 304 of file reference_manager.F.

Here is the call graph for this function:

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 340 of file reference_manager.F.

Here is the caller graph for this function:

Variable Documentation

nbib

integer, save reference_manager::nbib = 0

Definition at line 73 of file reference_manager.F.