layout | title | nav_exclude |
---|---|---|
default |
pymatgen.cli.md |
true |
- TOC {:toc}
This package contains various command line interfaces for common pymatgen functionality such as file conversion, etc. Entry points to these interfaces are defined in setup.py.
Script for plotting cross sections generated by FEFF found in xmu.dat files.
Main function.
Script to plot density of states (DOS) generated by an FEFF run either by site, element, or orbital.
Main function.
Command line script to get the chemical environment of a structure.
Main function for get_environment CLI.
A master convenience script with many tools for vasp and structure analysis.
Handle diff commands.
-
Parameters
args – Args from command.
Handle main.
Handle view commands.
-
Parameters
args – Args from command.
Implementation for pmg analyze CLI.
Master function controlling which analysis to call.
-
Parameters
args (dict) – args from argparse.
Get energies of all vaspruns in directory (nested).
-
Parameters
-
rootdir (str) – Root directory.
-
reanalyze (bool) – Whether to ignore saved results and reanalyze
-
verbose (bool) – Verbose mode or not.
-
quick (bool) – Whether to perform a quick analysis (using OSZICAR instead of vasprun.xml
-
sort (bool) – Whether to sort the results in ascending order.
-
fmt (str) – tablefmt passed to tabulate.
-
Get magnetization info from OUTCARs.
-
Parameters
-
dir (str) – Directory name
-
ion_list (list*[int]*) – List of ions to obtain magnetization information for.
-
-
Returns
0 if successful.
-
Return type
int
Implementation for pmg config CLI.
Add/update keys in .pmgrc.yaml config file.
Build bader package.
-
Parameters
fortran_command –
Build enum.
-
Parameters
fortran_command –
Handle configure command.
Install all optional external software.
Setup CP2K basis and potential data directory.
Setup POTCAR directories.
Implementation for pmg plot CLI.
Plot integrated charge.
-
Parameters
-
args (dict) – args from argparse.
-
ax (plt.Axes) – Matplotlib Axes object for plotting.
-
-
Returns
Matplotlib Axes object.
-
Return type
plt.Axes
Plot DOS.
-
Parameters
args (dict) – Args from argparse.
Plot XRD.
-
Parameters
args (dict) – Args from argparse
Master control method calling other plot methods based on args.
-
Parameters
args (dict) – Args from argparse.
Implementation for pmg potcar CLI.
Generate POTCAR from POTCAR.spec in directories.
-
Parameters
-
dirname (str) – Directory name.
-
filename (str) – Filename in directory.
-
Generate POTCAR.
-
Parameters
args (dict) – Args from argparse.
Process a directory.
-
Parameters
-
dirname (str) – Directory name.
-
procfilefunction (callable) – Callable to execute on directory.
-
Implementation for pmg query CLI.
Perform query to the Materials Project.
-
Parameters
args (dict) – Args from argparse.
Implementation for pmg structure CLI.
Analyze local env of structures in files.
-
Parameters
args (dict) – Args for argparse.
Master function to handle which operation to perform.
-
Parameters
args (dict) – Args from argparse.
Analyze symmetry of structures in files.
-
Parameters
args (dict) – Args from argparse.
Compare structures in files for similarity using structure matcher.
-
Parameters
args (dict) – Args from argparse.
Convert files from one format to another.
-
Parameters
args (dict) – Args from argparse.