Author#

class aastex.Author(name, affiliation, orcid=None, email=None)[source]#

Bases: LatexObject

One of the authors of this article

Attributes

`begin_paragraph`	Start a new paragraph before this environment.
`email`	The optional email address of the author.
`end_paragraph`	Start a new paragraph after this environment.
`escape`	Determine whether or not to escape content of this class.
`latex_name`	Return the name of the class used in LaTeX.
`orcid`	The optional ORCID of the author.
`packages`
`separate_paragraph`	Same as enabling begin_paragraph and end_paragraph, so effectively placing this element in its own paragraph.
`name`	Name of the author
`affiliation`	The organization affiliated with the author

Methods

`__init__`(name, affiliation[, orcid, email])
`dump`(file_w)	Write the LaTeX representation of the class to a file.
`dump_packages`(file_w)	Write the LaTeX representation of the packages to a file.
`dumps`()	Represent the class as a string in LaTeX syntax.
`dumps_as_content`()	Create a string representation of the object as content.
`dumps_packages`()	Represent the packages needed as a string in LaTeX syntax.
`generate_tex`(filepath)	Generate a .tex file.

Inheritance Diagram

Parameters:

name (str)
affiliation (Affiliation)
orcid (None | str)
email (None | str)

dump(file_w)#

Write the LaTeX representation of the class to a file.

Parameters:: file_w (io.TextIOBase) – The file object in which to save the data

dump_packages(file_w)#

Write the LaTeX representation of the packages to a file.

Parameters:: file_w (io.TextIOBase) – The file object in which to save the data

dumps()[source]#

Represent the class as a string in LaTeX syntax.

This method should be implemented by any class that subclasses this class.

Return type:: str

dumps_as_content()#

Create a string representation of the object as content.

This is currently only used to add new lines before and after the output of the dumps function. These can be added or removed by changing the begin_paragraph, end_paragraph and separate_paragraph attributes of the class.

dumps_packages()#

Represent the packages needed as a string in LaTeX syntax.

Return type:: list

generate_tex(filepath)#

Generate a .tex file.

Parameters:: filepath (str) – The name of the file (without .tex)

affiliation: Affiliation#: The organization affiliated with the author

begin_paragraph = False#: Start a new paragraph before this environment.

email: None | str = None#

The optional email address of the author.

If this is not None, this author is assumed to be the corresponding author.

end_paragraph = False#: Start a new paragraph after this environment.

property escape#

Determine whether or not to escape content of this class.

This defaults to True for most classes.

property latex_name#

Return the name of the class used in LaTeX.

It can be None when the class doesn’t have a name.

name: str#: Name of the author

orcid: None | str = None#: The optional ORCID of the author.

packages = OrderedSet()#

separate_paragraph = False#: Same as enabling begin_paragraph and end_paragraph, so effectively placing this element in its own paragraph.