API Reference

Here you’ll find API documentation of the mendeleev’s modules. For most users it’ll be enough to use the high-level API provided by the classes below. For more advanced use cases you can use the lower-level functions and classes across the modules.

Tip

New to the API? Start with the API Overview for architecture explanations, usage patterns, and a decision guide to help you choose the right functions.

Core Modules

High-level functions and classes for accessing element data.

mendeleev.mendeleev

Entry point for the Mendeleev package for instantiating elements and isotopes.

mendeleev.fetch

Utility functions to fetch data from the database in bulk

mendeleev.ion

Module defining the database models for ions.

Data Models

SQLAlchemy models representing chemical entities and properties.

mendeleev.models

Module defining the database models for elements and related properties.

Specialized Modules

Modules for specific calculations and data processing.

mendeleev.electronegativity

Electronegativity scale formulas.

mendeleev.econf

Implementation of the abstraction for the elctronic configuration object.

Utility Modules

Database access and utility functions.

mendeleev.db

Low-level database access functions.

mendeleev.utils

Utility functions for Mendeleev package.

mendeleev.cli

Module defining the command line interface for mendeleev.

Visualization

The main entry point for visualizing periodic tables with different properties is the mendeleev.vis.periodictable.periodic_table() function.