<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article id="index" lang="en">

<articleinfo>
	<title>pyElemental reference</title>
	<releaseinfo>This manual describes version 1.2.0 of pyElemental.</releaseinfo>

	<authorgroup>
		<author role="maintainer">
			<firstname>Kevin</firstname><surname>Daughtridge</surname>
			<affiliation><address><email>kevin+gelemental@kdau.com</email></address></affiliation>
		</author>
	</authorgroup>

	<copyright><year>2007</year><holder>Kevin Daughtridge</holder></copyright>
<!-- Translators: Uncomment this:
	<copyright><year>YEAR</year><holder>TRANSLATOR-NAME (LANGUAGE translation)</holder></copyright>
-->
	<legalnotice id="legalnotice">
		<para>This document is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</para>
		<para>This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</para>
		<para>You should have received a copy of the GNU General Public License along with this document. If not, see <ulink url="http://www.gnu.org/licenses/">the GNU project</ulink>.</para>
	</legalnotice>
</articleinfo>

<sect1 id="intro">
	<title>Introduction</title>
	<para>pyElemental is a periodic table module for <ulink url="http://www.python.org/">Python</ulink> with detailed information on chemical elements. It is free software released under the GNU <ulink url="http://www.gnu.org/licenses/gpl.html">General Public License</ulink>, version 3 or later.</para>
	<para>pyElemental comprises the <package>Elemental</package> module, which is a binding for <ulink url="http://www.kdau.com/projects/gelemental/">gElemental</ulink>'s data library. pyElemental attempts to maintain a close correspondence to the libelemental API, whose documentation may serve as an additional reference. Where not otherwise stated here, the behaviour of classes and methods is equivalent.</para>
</sect1>

<sect1 id="value">
	<title>Basic classes and data</title>
	<para>This attribute is available at the module level:</para>
	<variablelist>
		<varlistentry>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>float</type><varname>STANDARD_TEMPERATURE</varname></fieldsynopsis></term>
			<listitem><para>The standard temperature, in Kelvin, as defined by IUPAC.</para></listitem>
		</varlistentry>
	</variablelist>

	<sect2 id="qualifiers">
		<title>Qualifiers</title>
		<para>A qualifier is a qualification of the meaning of a value. These read-only <type>int</type> attributes at the module level are valid as qualifiers:</para>
		<variablelist><?dbhtml list-presentation="table"?>
			<varlistentry><term><varname>Q_NEUTRAL</varname></term><listitem>Indicates a presumably valid value.</listitem></varlistentry>
			<varlistentry><term><varname>Q_UNK</varname></term><listitem>Indicates that a value is unknown or unavailable.</listitem></varlistentry>
			<varlistentry><term><varname>Q_NA</varname></term><listitem>Indicates that a value is not applicable for an element.</listitem></varlistentry>
			<varlistentry><term><varname>Q_EST</varname></term><listitem>Indicates that a value is estimated or calculated.</listitem></varlistentry>
			<varlistentry><term><varname>Q_CA</varname></term><listitem>Indicates that a value is approximate.</listitem></varlistentry>
			<varlistentry><term><varname>Q_ISO</varname></term><listitem>Indicates a value for the most stable isotope of an element.</listitem></varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-color" xreflabel="color">
		<title>class <classname>color</classname></title>
		<para>A color description.</para>
		<variablelist>
			<varlistentry>
				<term><constructorsynopsis language="python">>
					<methodname>color</methodname>
					<methodparam choice="opt"><type>float</type><parameter>red</parameter><initializer>0.0</initializer></methodparam>
					<methodparam choice="opt"><type>float</type><parameter>green</parameter><initializer>0.0</initializer></methodparam>
					<methodparam choice="opt"><type>float</type><parameter>blue</parameter><initializer>0.0</initializer></methodparam>
				</constructorsynopsis></term>
				<listitem><para>Initializes a color with optional red, green, and blue component percentages.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><type>float</type><varname>red</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><type>float</type><varname>green</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><type>float</type><varname>blue</varname></fieldsynopsis></term>
				<listitem><para>The red, green, and blue components of the color in the RGB space, each between 0.0 and 1.0.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>float</type><varname>luminance</varname></fieldsynopsis></term>
				<listitem><para>The luminous intensity of the color, between 0.0 and 1.0.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type role="local">color</type><varname>compliment</varname></fieldsynopsis></term>
				<listitem><para>A grayscale color complimentary in luminance to this color.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>str</type><varname>hex_spec</varname></fieldsynopsis></term>
				<listitem><para>A hexadecimal specification of the color (&quot;#rrggbb&quot; format).</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><type>color</type><methodname>composite</methodname>
					<methodparam><type>color</type><parameter>other</parameter></methodparam>
					<methodparam><type>float</type><parameter>alpha</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Returns a composite of this color and another.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>other</parameter></term><listitem>A color with which this color will be composited.</listitem></varlistentry>
						<varlistentry><term><parameter>alpha</parameter></term><listitem>The level of the other color in the composite, between 0.0 and 1.0.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-EntriesView" xreflabel="EntriesView">
		<title>class <classname>EntriesView</classname></title>
		<para>An interface for the display of value entries.</para>
		<para>Instances of this class cannot be created directly. For basic text output, use an <classname><xref linkend="class-EntriesStream" /></classname>. For other needs, define a subclass of this class with <methodname>header</methodname> and <methodname>entry</methodname> methods.</para>
		<variablelist>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>header</methodname>
					<methodparam><type>unicode</type><parameter>category</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Displays a category header. Raises <exceptionname>NotImplementedError</exceptionname>; must be implemented in subclasses.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>category</parameter></term><listitem>The name of the category.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>entry</methodname>
					<methodparam><type>unicode</type><parameter>name</parameter></methodparam>
					<methodparam><type>unicode</type><parameter>value</parameter></methodparam>
					<methodparam choice="opt"><type>unicode</type><parameter>tip</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Displays a single value entry. Raises <exceptionname>NotImplementedError</exceptionname>; must be implemented in subclasses.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>name</parameter></term><listitem>The name of the entry.</listitem></varlistentry>
						<varlistentry><term><parameter>value</parameter></term><listitem>A localized string representation of the value of the entry.</listitem></varlistentry>
						<varlistentry><term><parameter>tip</parameter></term><listitem>Qualifying information, if any, to be displayed as a tip.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-EntriesStream" xreflabel="EntriesStream">
		<title>class <classname>EntriesStream</classname></title>
		<para>An adapter for the display of value entries on an output stream.</para>
		<variablelist>
			<varlistentry>
				<term><constructorsynopsis language="python">>
					<methodname>EntriesStream</methodname>
					<methodparam><type>file</type><parameter>file</parameter></methodparam>
				</constructorsynopsis></term>
				<listitem><para>Initializes an EntriesStream with a file or file-like object such as <varname>sys.stdout</varname>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>header</methodname>
					<methodparam><type>unicode</type><parameter>category</parameter></methodparam>
				</methodsynopsis></term>
				<listitem><para>Implemented here; see <classname><xref linkend="class-EntriesView" /></classname>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>entry</methodname>
					<methodparam><type>unicode</type><parameter>name</parameter></methodparam>
					<methodparam><type>unicode</type><parameter>value</parameter></methodparam>
					<methodparam choice="opt"><type>unicode</type><parameter>tip</parameter></methodparam>
				</methodsynopsis></term>
				<listitem><para>Implemented here; see <classname><xref linkend="class-EntriesView" /></classname>.</para></listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-value_base" xreflabel="value_base">
		<title>class <classname>value_base</classname></title>
		<para>A base class for qualified values.</para>
		<para>Instances of this class cannot be created directly. This class and its subclasses support the <methodname>str</methodname> and <methodname>cmp</methodname> functions.</para>
		<variablelist>
			<varlistentry>
				<term><fieldsynopsis language="python"><type>int</type><varname>qualifier</varname></fieldsynopsis></term>
				<listitem><para>The qualification of the value's meaning. Must be equal to one of the <link linkend="qualifiers">qualifier constants</link>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>bool</type><varname>has_value</varname></fieldsynopsis></term>
				<listitem><para>Whether the value is defined.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><type>unicode</type><methodname>get_string</methodname>
					<methodparam choice="opt"><type>unicode</type><parameter>format</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Returns a localized text representation of the value.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>format</parameter></term><listitem>An optional compose-style format string with which to output the value. If not otherwise specified, the value is argument reference &quot;%1&quot;.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type role="local">unicode</type><varname>tip</varname></fieldsynopsis></term>
				<listitem><para>A localized message to be displayed as a tooltip.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>make_entry</methodname>
					<methodparam><type>EntriesView</type><parameter>view</parameter></methodparam>
					<methodparam><type>unicode</type><parameter>name</parameter></methodparam>
					<methodparam choice="opt"><type>unicode</type><parameter>format</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Possibly adds the result of <methodname>get_string</methodname> to an <link linkend="class-EntriesView"><classname>EntriesView</classname></link>. An entry will only be made if the value is defined or belongs to an always-output class.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>view</parameter></term><listitem>The <classname>EntriesView</classname> to be populated.</listitem></varlistentry>
						<varlistentry><term><parameter>name</parameter></term><listitem>The name of the value to be passed.</listitem></varlistentry>
						<varlistentry><term><parameter>format</parameter></term><listitem>An optional compose-style format for <methodname>get_string</methodname>.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-color_value_base" xreflabel="color_value_base">
		<title>class <classname>color_value_base</classname></title>
		<para>A base class for qualified values which have representative colors. Inherits from <classname><xref linkend="class-value_base" /></classname>.</para>
		<variablelist>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>color</type><varname>color</varname></fieldsynopsis></term>
				<listitem><para>A <classname><xref linkend="class-color" /></classname> representing the value.</para></listitem>
			</varlistentry>
		</variablelist>
	</sect2>
</sect1>

<sect1 id="value-types">
	<title>Value types</title>

	<sect2 id="value-classes">
		<title>Value classes</title>
		<para>These value classes inherit from <classname><xref linkend="class-value_base" /></classname>:</para>
		<itemizedlist>
			<listitem id="class-Float" xreflabel="Float"><classname>Float</classname> (<type>float</type>)</listitem>
			<listitem id="class-Int" xreflabel="Int"><classname>Int</classname> (<type>int</type>)</listitem>
			<listitem id="class-String" xreflabel="String"><classname>String</classname> (<type>unicode</type>&mdash;does not require translation)</listitem>
			<listitem id="class-Message" xreflabel="Message"><classname>Message</classname> (<type>unicode</type>&mdash;requires translation)</listitem>
		</itemizedlist>
		<para>These value classes inherit from <classname><xref linkend="class-color_value_base" /></classname>:</para>
		<itemizedlist>
			<listitem><classname><xref linkend="class-Series" /></classname></listitem>
			<listitem><classname><xref linkend="class-Block" /></classname></listitem>
			<listitem><classname><xref linkend="class-Phase" /></classname></listitem>
			<listitem><classname><xref linkend="class-LatticeType" /></classname></listitem>
			<listitem id="class-ColorValue" xreflabel="ColorValue"><classname>ColorValue</classname> (<classname><xref linkend="class-color" /></classname>)</listitem>
		</itemizedlist>
		<para>These methods and attributes are present in each value class, where TYPE is the type held by the class, as listed above:</para>
		<variablelist>
			<varlistentry>
				<term><constructorsynopsis language="python">>
					<methodname>__init__</methodname>
					<methodparam choice="opt"><type>TYPE</type><parameter>value</parameter></methodparam>
					<methodparam choice="opt"><type>int</type><parameter>qualifier</parameter></methodparam>
				</constructorsynopsis></term>
				<listitem><para>If <parameter>value</parameter> is given, <parameter>qualifier</parameter> defaults to <varname>Q_NEUTRAL</varname>. If not, <parameter>qualifier</parameter> defaults to <varname>Q_UNK</varname>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><type>TYPE</type><varname>value</varname></fieldsynopsis></term>
				<listitem><para>The value, if defined.</para></listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="value-list-classes">
		<title>Value list classes</title>
		<para>These value list classes inherit from <classname><xref linkend="class-value_base" /></classname>:</para>
		<itemizedlist>
			<listitem id="class-FloatList" xreflabel="FloatList"><classname>FloatList</classname> (<type>float</type>)</listitem>
			<listitem id="class-IntList" xreflabel="IntList"><classname>IntList</classname> (<type>int</type>)</listitem>
		</itemizedlist>
		<para>These methods and attributes are present in each value list class, where TYPE is the type held by the class, as listed above:</para>
		<variablelist>
			<varlistentry>
				<term><constructorsynopsis language="python">>
					<methodname>__init__</methodname>
					<methodparam choice="opt"><type>list(TYPE)</type><parameter>values</parameter></methodparam>
					<methodparam choice="opt"><type>int</type><parameter>qualifier</parameter></methodparam>
				</constructorsynopsis></term>
				<listitem><para>If <parameter>values</parameter> are given, <parameter>qualifier</parameter> defaults to <varname>Q_NEUTRAL</varname>. If not, <parameter>qualifier</parameter> defaults to <varname>Q_UNK</varname>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><type>list(TYPE)</type><varname>values</varname></fieldsynopsis></term>
				<listitem><para>A <type>list</type> of TYPE values, if defined.</para></listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-Event" xreflabel="Event">
		<title>class <classname>Event</classname></title>
		<para>A qualified value representing the time and location of an event.</para>
		<variablelist>
			<varlistentry>
				<term><constructorsynopsis language="python">>
					<methodname>Event</methodname>
					<methodparam choice="opt"><type>int</type><parameter>when</parameter></methodparam>
					<methodparam choice="opt"><type>unicode</type><parameter>where</parameter></methodparam>
					<methodparam choice="opt"><type>int</type><parameter>qualifier</parameter></methodparam>
				</constructorsynopsis></term>
				<listitem><para>If <parameter>when</parameter> and <parameter>where</parameter> are given, <parameter>qualifier</parameter> defaults to <varname>Q_NEUTRAL</varname>. If not, <parameter>qualifier</parameter> defaults to <varname>Q_UNK</varname>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><type>int</type><varname>when</varname></fieldsynopsis></term>
				<listitem><para>The year in which the event occurred, if defined.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><type>unicode</type><varname>where</varname></fieldsynopsis></term>
				<listitem><para>The place in which the event occurred, if defined.</para></listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-Series" xreflabel="Series">
		<title>class <classname>Series</classname></title>
		<para>A qualified value representing a chemical series. See the <link linkend="value-classes">value class synopsis</link>.</para>
		<para>These read-only <type>int</type> attributes of class <classname>Series</classname> are the valid values of <varname>Series.value</varname>:</para>
		<variablelist><?dbhtml list-presentation="table"?>
			<varlistentry><term><varname>Series.NONMETAL</varname></term><listitem>nonmetals</listitem></varlistentry>
			<varlistentry><term><varname>Series.NOBLE_GAS</varname></term><listitem>noble gases</listitem></varlistentry>
			<varlistentry><term><varname>Series.ALKALI_METAL</varname></term><listitem>alkali metals</listitem></varlistentry>
			<varlistentry><term><varname>Series.ALKALINE_EARTH_METAL</varname></term><listitem>alkaline earth metals</listitem></varlistentry>
			<varlistentry><term><varname>Series.SEMIMETAL</varname></term><listitem>semimetals</listitem></varlistentry>
			<varlistentry><term><varname>Series.HALOGEN</varname></term><listitem>halogens</listitem></varlistentry>
			<varlistentry><term><varname>Series.POST_TRANSITION_METAL</varname></term><listitem>post-transition metals</listitem></varlistentry>
			<varlistentry><term><varname>Series.TRANSITION_METAL</varname></term><listitem>transition metals</listitem></varlistentry>
			<varlistentry><term><varname>Series.LANTHANIDE</varname></term><listitem>lanthanides</listitem></varlistentry>
			<varlistentry><term><varname>Series.ACTINIDE</varname></term><listitem>actinides</listitem></varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-Block" xreflabel="Block">
		<title>class <classname>Block</classname></title>
		<para>A qualified value representing a periodic table block. See the <link linkend="value-classes">value class synopsis</link>.</para>
		<para>These read-only <type>int</type> attributes of class <classname>Block</classname> are the valid values of <varname>Block.value</varname>:</para>
		<variablelist><?dbhtml list-presentation="table"?>
			<varlistentry><term><varname>Block.S</varname></term><listitem>s-block (sharp)</listitem></varlistentry>
			<varlistentry><term><varname>Block.P</varname></term><listitem>p-block (principal)</listitem></varlistentry>
			<varlistentry><term><varname>Block.D</varname></term><listitem>d-block (diffuse)</listitem></varlistentry>
			<varlistentry><term><varname>Block.F</varname></term><listitem>f-block (fundamental)</listitem></varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-Phase" xreflabel="Phase">
		<title>class <classname>Phase</classname></title>
		<para>A qualified value representing a phase of matter. See the <link linkend="value-classes">value class synopsis</link>.</para>
		<para>These read-only <type>int</type> attributes of class <classname>Phase</classname> are the valid values of <varname>Phase.value</varname>:</para>
		<variablelist><?dbhtml list-presentation="table"?>
			<varlistentry><term><varname>Phase.SOLID</varname></term><listitem>solid</listitem></varlistentry>
			<varlistentry><term><varname>Phase.LIQUID</varname></term><listitem>liquid</listitem></varlistentry>
			<varlistentry><term><varname>Phase.GAS</varname></term><listitem>gas</listitem></varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-LatticeType" xreflabel="LatticeType">
		<title>class <classname>LatticeType</classname></title>
		<para>A qualified value representing a Bravais lattice type. See the <link linkend="value-classes">value class synopsis</link>.</para>
		<para>These read-only <type>int</type> attributes of class <classname>LatticeType</classname> are the valid values of <varname>LatticeType.value</varname>:</para>
		<variablelist><?dbhtml list-presentation="table"?>
			<varlistentry><term><varname>LatticeType.TRI</varname></term><listitem>triclinic</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.MONO</varname></term><listitem>monoclinic</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.ORTH</varname></term><listitem>orthorhombic</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.TET</varname></term><listitem>tetragonal</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.RHO</varname></term><listitem>rhombohedral</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.HEX</varname></term><listitem>hexagonal</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.SC</varname></term><listitem>simple cubic</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.BCC</varname></term><listitem>body-centered cubic</listitem></varlistentry>
			<varlistentry><term><varname>LatticeType.FCC</varname></term><listitem>face-centered cubic</listitem></varlistentry>
		</variablelist>
	</sect2>
</sect1>

<sect1 id="properties">
	<title>Categories and properties</title>
	<para>These attributes are available at the module level:</para>
	<variablelist>
		<varlistentry>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>list(Category)</type><varname>categories</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_GENERAL</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_HISTORICAL</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_PHYSICAL</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_THERMAL</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_ATOMIC</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_CRYSTALLOGRAPHIC</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_ELECTRONIC</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Category</type><varname>C_MISCELLANEOUS</varname></fieldsynopsis></term>
			<listitem><para>The <link linkend="class-Category">categories</link> of available properties of the chemical elements, and a list thereof.</para></listitem>
		</varlistentry>
		<varlistentry>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_NAME</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_OFFICIAL_NAME</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_ALTERNATE_NAME</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_SYMBOL</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_NUMBER</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_SERIES</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_GROUP</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_PERIOD</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_BLOCK</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_DISCOVERY</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_DISCOVERED_BY</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_ETYMOLOGY</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_PHASE</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_DENSITY_SOLID</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_DENSITY_LIQUID</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_DENSITY_GAS</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_APPEARANCE</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_MELTING_POINT</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_BOILING_POINT</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_FUSION_HEAT</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_VAPORIZATION_HEAT</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_SPECIFIC_HEAT</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_THERMAL_CONDUCTIVITY</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_DEBYE_TEMPERATURE</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_ATOMIC_MASS</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_ATOMIC_VOLUME</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_ATOMIC_RADIUS</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_COVALENT_RADIUS</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_VAN_DER_WAALS_RADIUS</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_IONIC_RADII</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_LATTICE_TYPE</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_SPACE_GROUP</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_LATTICE_EDGES</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_LATTICE_ANGLES</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_LATTICE_VOLUME</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_CONFIGURATION</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_OXIDATION_STATES</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_ELECTRONEGATIVITY</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_ELECTRON_AFFINITY</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatProperty</type><varname>P_FIRST_ENERGY</varname></fieldsynopsis></term>

			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_COLOR</varname></fieldsynopsis></term>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>Property</type><varname>P_NOTES</varname></fieldsynopsis></term>

			<listitem><para>The available <link linkend="class-Property">properties</link> (including <link linkend="class-FloatProperty">floating-point properties</link>) of the chemical elements. For details, see the <varname>description</varname> attribute of each property.</para></listitem>
		</varlistentry>
	</variablelist>
	
	<sect2 id="class-Property" xreflabel="Property">
		<title>class <classname>Property</classname></title>
		<para>A property of the chemical elements. Property instances are accessible through the <varname>properties</varname> <type>list</type>s of <link linkend="class-Category">categories</link>, or as module-level attributes (see <link linkend="properties">above</link>).</para>
		<variablelist>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>unicode</type><varname>name</varname></fieldsynopsis></term>
				<listitem><para>The translated name of the property.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>bool</type><varname>has_format</varname></fieldsynopsis></term>
				<listitem><para>Whether a compose-style format for values is defined.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>unicode</type><varname>format</varname></fieldsynopsis></term>
				<listitem><para>A translated compose-style format for values of the property. If the format is undefined, an empty string.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>unicode</type><varname>description</varname></fieldsynopsis></term>
				<listitem><para>A translated explanatory description of the property.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>list(Message)</type><varname>sources</varname></fieldsynopsis></term>
				<listitem><para>Citations for the sources of values for the property, as <classname><xref linkend="class-Message" /></classname>s.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>bool</type><varname>is_colorable</varname></fieldsynopsis></term>
				<listitem><para>Whether values of the property have color representations.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>make_entry</methodname>
					<methodparam><type>EntriesView</type><parameter>view</parameter></methodparam>
					<methodparam><type>unicode|value_base</type><parameter>value</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Possibly adds a value for this property to an <classname><xref linkend="class-EntriesView" /></classname>. If <parameter>value</parameter> is <type>unicode</type>, an entry will always be made. If <parameter>value</parameter> is a <classname><xref linkend="class-value_base" /></classname> subclass, an entry will be made only if <parameter>value</parameter> is defined or belongs to an always-output class.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>view</parameter></term><listitem>The <classname>EntriesView</classname> to be populated.</listitem></varlistentry>
						<varlistentry><term><parameter>value</parameter></term><listitem>The value to be added.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-FloatProperty" xreflabel="FloatProperty">
		<title>class <classname>FloatProperty</classname></title>
		<para>A floating-point property of the chemical elements. Inherits from <classname><xref linkend="class-Property" /></classname>.</para>
		<variablelist>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>bool</type><varname>is_scale_valid</varname></fieldsynopsis></term>
				<listitem><para>Whether the scale of values for this property is valid. The scale is valid if one or more elements has a defined value for this property and those values are not all equal.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><type>float</type><methodname>get_scale_position</methodname>
					<methodparam><type>Float</type><parameter>instance</parameter></methodparam>
					<methodparam choice="opt"><type>bool</type><parameter>logarithmic</parameter><initializer>False</initializer></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Returns the position on a normalized 0.0 to 1.0 scale for an instance of this property. Raises <exceptionname>ValueError</exceptionname> if the property does not have a valid scale, or if <parameter>instance</parameter> is not a defined value.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>instance</parameter></term><listitem>A defined <classname><xref linkend="class-Float" /></classname> value for this property.</listitem></varlistentry>
						<varlistentry><term><parameter>logarithmic</parameter></term><listitem>Whether to compute the position on a logarithmic instead of linear scale.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>float</type><varname>minimum</varname></fieldsynopsis></term>
				<listitem><para>The least value of this property for any element. Raises <exceptionname>ValueError</exceptionname> if the property does not have a valid scale.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>float</type><varname>linear_medium</varname></fieldsynopsis></term>
				<listitem><para>The value of this property that has a position of 0.5 on a linear scale. Raises <exceptionname>ValueError</exceptionname> if the property does not have a valid scale.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>float</type><varname>logarithmic_medium</varname></fieldsynopsis></term>
				<listitem><para>The value of this property that has a position of 0.5 on a logarithmic scale. Raises <exceptionname>ValueError</exceptionname> if the property does not have a valid scale.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>float</type><varname>maximum</varname></fieldsynopsis></term>
				<listitem><para>The greatest value of this property for any element. Raises <exceptionname>ValueError</exceptionname> if the property does not have a valid scale.</para></listitem>
			</varlistentry>
		</variablelist>
	</sect2>
	
	<sect2 id="class-Category" xreflabel="Category">
		<title>class <classname>Category</classname></title>
		<para>A category of properties of the chemical elements. Categories instances are accessible through the <varname>categories</varname> <type>list</type>, or as module-level attributes (see <link linkend="properties">above</link>).</para>
		<variablelist>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>unicode</type><varname>name</varname></fieldsynopsis></term>
				<listitem><para>The translated name of the category.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>list(Property)</type><varname>properties</varname></fieldsynopsis></term>
				<listitem><para>The <link linkend="class-Property">properties</link> in the category.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>make_header</methodname>
					<methodparam><type>EntriesView</type><parameter>view</parameter></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Adds the category name to an EntriesView.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>view</parameter></term><listitem>The <classname><xref linkend="class-EntriesView" /></classname> to be populated.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
		</variablelist>
	</sect2>
</sect1>

<sect1 id="table">
	<title>Periodic table</title>
	<para>This method and attribute are available at the module level:</para>
	<variablelist>
		<varlistentry>
			<term><fieldsynopsis language="python"><modifier>const</modifier><type>list(Element)</type><varname>table</varname></fieldsynopsis></term>
			<listitem><para>The periodic table of elements. A <type>list</type> of <classname><xref linkend="class-Element" /></classname>s in atomic number order.</para></listitem>
		</varlistentry>
		<varlistentry>
			<term><methodsynopsis language="python"><type>Element</type><methodname>get_element</methodname>
				<methodparam><type>int|str</type><parameter>which</parameter></methodparam>
			</methodsynopsis></term>
			<listitem>
				<para>Returns the element with a given symbol or atomic number. Raises <exceptionname>KeyError</exceptionname> if the symbol or number is invalid.</para>
				<variablelist><?dbhtml list-presentation="table"?>
					<varlistentry><term><parameter>which</parameter></term><listitem>If <type>int</type>, the atomic number of an element. If <type>str</type>, the symbol or atomic number of an element.</listitem></varlistentry>
				</variablelist>
			</listitem>
		</varlistentry>
	</variablelist>
	
	<sect2 id="class-Element" xreflabel="Element">
		<title>class <classname>Element</classname></title>
		<para>A chemical element.</para>
		<variablelist>
			<varlistentry>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Message</type><varname>name</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>String</type><varname>official_name</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>String</type><varname>alternate_name</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>str</type><varname>symbol</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>int</type><varname>number</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Series</type><varname>series</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>int</type><varname>group</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>int</type><varname>period</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Block</type><varname>block</varname></fieldsynopsis></term>

				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Event</type><varname>discovery</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Message</type><varname>discovered_by</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Message</type><varname>etymology</varname></fieldsynopsis></term>

				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Phase</type><varname>phase</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>density_solid</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>density_liquid</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>density_gas</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Message</type><varname>appearance</varname></fieldsynopsis></term>

				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>melting_point</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>boiling_point</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>fusion_heat</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>vaporization_heat</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>specific_heat</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>thermal_conductivity</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>debye_temperature</varname></fieldsynopsis></term>


				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>atomic_mass</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>atomic_volume</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>atomic_radius</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>covalent_radius</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>van_der_waals_radius</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>String</type><varname>ionic_radii</varname></fieldsynopsis></term>

				<term><fieldsynopsis language="python"><modifier>const</modifier><type>LatticeType</type><varname>lattice_type</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Int</type><varname>space_group</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatList</type><varname>lattice_edges</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>FloatList</type><varname>lattice_angles</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>lattice_volume</varname></fieldsynopsis></term>

				<term><fieldsynopsis language="python"><modifier>const</modifier><type>String</type><varname>configuration</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>IntList</type><varname>oxidation_states</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>electronegativity</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>electron_affinity</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Float</type><varname>first_energy</varname></fieldsynopsis></term>

				<term><fieldsynopsis language="python"><modifier>const</modifier><type>ColorValue</type><varname>color</varname></fieldsynopsis></term>
				<term><fieldsynopsis language="python"><modifier>const</modifier><type>Message</type><varname>notes</varname></fieldsynopsis></term>

				<listitem><para>The chemical properties of the element. For details, see their <link linkend="properties">property definitions</link>.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><void /><methodname>make_entries</methodname>
					<methodparam><type>EntriesView</type><parameter>view</parameter></methodparam>
					<methodparam choice="opt"><type>Category</type><parameter>category</parameter></methodparam>
					<methodparam choice="opt"><type>bool</type><parameter>all</parameter><initializer>False</initializer></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Generates entries for all properties, or for the properties in the given category.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>view</parameter></term><listitem>The <classname><xref linkend="class-EntriesView" /></classname> to be populated.</listitem></varlistentry>
						<varlistentry><term><parameter>category</parameter></term><listitem>The <classname><xref linkend="class-Category" /></classname> whose properties will be provided. If not given, all properties are used.</listitem></varlistentry>
						<varlistentry><term><parameter>all</parameter></term><listitem>For <varname>C_GENERAL</varname>, controls whether the <classname>EntriesView</classname> will also receive the element's primary name, symbol, and atomic number.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><methodsynopsis language="python"><type>Phase</type><methodname>get_phase</methodname>
					<methodparam choice="opt"><type>float</type><parameter>tempK</parameter><initializer>STANDARD_TEMPERATURE</initializer></methodparam>
				</methodsynopsis></term>
				<listitem>
					<para>Returns the phase of matter assumed by the element at standard pressure and a given temperature.</para>
					<variablelist><?dbhtml list-presentation="table"?>
						<varlistentry><term><parameter>tempK</parameter></term><listitem>The temperature, in Kelvin, at which to determine phase. By default, the IUPAC standard temperature.</listitem></varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>
		</variablelist>
	</sect2>
</sect1>

</article>