api

A module containing the API for reading and writing topology files.

Summary

Functions:

read_topology_file	Function to read a topology file.
write_topology_file	Wrapper function to write a topology file.

Reference

read_topology_file(

filename: str,

) → BondedTopology

Function to read a topology file.

Parameters:

filename (str) – The filename of the topology file.

Returns:

The bonded topology.

Return type:

BondedTopology

write_topology_file(

bonded_topology: Topology | BondedTopology,

filename: str | None = None,

mode: FileWritingMode | str = 'w',

) → None

Wrapper function to write a topology file.