mooonpy package

class mooonpy.Molspace(filename='', **kwargs)

Bases: object

Initializes a Molspace instance

This class can be called via:

• Full namespace syntax : mooonpy.molspace.molspace.Molspace()

• Aliased namespace syntax : mooonpy.Molspace()

Initialization Parameters

filenamestr, optional

An optional filename to read and initialize a Molspace() instance with molecular system information (e.g. atoms, bonds, force field parameters …). Supported file extensions:

• LAMMPS datafile .data

• Tripos mol2 file .mol2

• SYBL mol file .mol

If no filename is provided the Molspace instance will be generated with no molecular system information.

Attributes

Nint

The order of the filter. For ‘bandpass’ and ‘bandstop’ filters, the resulting order of the final second-order sections (‘sos’) matrix is 2*N, with N the number of biquad sections of the desired system.

Wnarray_like

The critical frequency or frequencies. For lowpass and highpass filters, Wn is a scalar; for bandpass and bandstop filters, Wn is a length-2 sequence.

Methods

Nint

The order of the filter. For ‘bandpass’ and ‘bandstop’ filters, the resulting order of the final second-order sections (‘sos’) matrix is 2*N, with N the number of biquad sections of the desired system.

KE()

add_type_labels(labels)

Adds type labels for atom types and use 1st instance for each BADI type label

could refactor the composition to a function somewhere

bonds_from_distances(periodicity: str = 'ppp')

Resets the bonds in a molecular system, based in interatomic distances and valences of atoms. The cutoff distances are set based on the summation of vdw radii per element involved in the bond. Each atom’s valence is respected (e.g. the maximum number of allowable bonded atoms to a carbon atom is 4).

Example:

>>> import mooonpy
>>> my_molecule = mooonpy.molspace('detda.data')
>>> my_molecule.bonds_from_distances(periodicity='fff')

Note

Before using this command the element per-atom info and element per-mass info need to be updated by running “my_molecule.update_elements()”.

Parameters:

periodicity (str) – Optional for setting the periodicity of the model, where f=fixed and p=periodic. Each position is a face (e.g. periodicity=’fpp’ is fixed on X-faces and periodic in Y- and Z-faces)

Returns:

None

Return type:

None

compute_ADI()

compute_BADI_by_type(periodicity='ppp', comp_bond=True, comp_angle=True, comp_dihedral=True, comp_improper=True)

Apply this command mol.ff.has_type_labels = True or mol.add_type_labels(labels) To make dict keys type labels

compute_bond_length(periodicity='ppp')

compute_pairs(cutoff, whitelist=None, blacklist=None, algorithm='DD_13', periodicity='ppp')

Compute pairwise distances within cutoff between atoms

copy()

find_cumulative_neighs()

find_rings(ring_sizes: tuple[int] = (3, 4, 5, 6, 7))

Finds all rings in the current Molspace instance. The size of rings searched for is set in the ring_sizes parameter.

Example:

>>> import mooonpy
>>> my_molecule = mooonpy.molspace('detda.mol2')
>>> rings = my_molecule.find_rings(ring_sizes=(3,4,5,6,7))
>>> print(rings)
[(1, 2, 3, 4, 5, 6)]

Note

Each ring will be sorted in the order it was traversed in the graph and will be in the canonical form (e.g., canonical=(1,2,3) vs non_canonical=(2,3,1)).

Parameters:

ring_sizes (tuple[int]) – Tuple containing ring sizes to search for in graph

Returns:

rings

Return type:

list[tuple[int]]

generate_graph()

read_files(filename, dsect=['all'], steps=Ellipsis)

Read files into Molspace Currently supports .data and .dump files.

Parameters:

• filename (str or Path) – path to file to read

• dsect (list) – Sections of data file to read, see mooonpy.molspace._files_io.read_lmp_data for more details

• steps (list or int) – Steps in dump file to read see mooonpy.molspace._files_io.read_lmp_dump for more details

Returns:

Modifies self in-place if data or single step, returns dict if multiple steps

Return type:

None or dict

Example:

>>> from mooonpy import Molspace
>>> MyPath = Path('Project/Monomers/DETDA.data')
>>> mol = Molspace(MyPath, dsect=['all'])
>>> MyPath2 = Path('Project/Monomers/DETDA.dump')
>>> series = Molspace(MyPath2, steps=None)

remove_atoms(atom_ids)

make smart and remove from some?

temp()

update_atoms(atoms, whitelist=None, blacklist=None, box=True)

Map per atom information from other atoms instance to this molspace

update_elements(type2mass=None, type2element=None)

Updates every per-atom .element attribute with the element type for that atom.

Example:

>>> import mooonpy
>>> my_molecule = mooonpy.molspace('detda.data')
>>> my_molecule.update_elements()

Note

This will also update the per-mass .element attribute in ff.masses dictionary as well.

Parameters:

• type2mass (dict[int, float]) – Optional for setting the atom type to mass map (e.g. type2mass={1: 12.01115, 2: 1.008}). If not provided this will be generated from the masses section.

• type2element (dict[int, str]) – Optional for setting the atom type to mass map (e.g. type2element={1: ‘C’, 2: ‘H’}). If not provided this will be generated from the masses section and interally defined periodic table.

Returns:

None

Return type:

None

write_files(filename, atom_style='full')

class mooonpy.Path(string: str | Path)

Bases: str

As computational scientists, half our jobs is file management and manipulation, the Path class contains several aliases for the os.path and glob.glob modules to make processing data easier. All mooonpy functions internally use this class for inputs of files or folders. Relevant strings are converted to path on entering functions

Examples

A copy of the code used in these examples is avalible in rootmooonpyexamplestoolspath_utilsexample_Path.py

Basic Path Operations

>>> project_path = Path('Project/Data/Analysis')
>>> filename = Path('results.txt')
>>> full_path = project_path / filename
>>> print(full_path)
Project\Data\Analysis\results.txt
>>> print(abs(full_path))
root\mooonpy\examples\tools\path_utils\Project\Data\Analysis\results.txt

Path Parsing

>>> sample_path = Path('experiments/run_001/data.csv.gz')
>>> print(sample_path.dir())
experiments\run_001
>>> print(sample_path.basename())
data.csv.gz
>>> print(sample_path.root())
data.csv
>>> print(sample_path.ext())
.gz

Extension Manipulation

>>> data_file = Path('analysis/results.txt')
>>> print(data_file.new_ext('.json'))
analysis\results.json
>>> print(data_file.new_ext('.txt.gz'))
analysis\results.txt.gz

File Existence

>>> current_file = Path(__file__)
>>> fake_file = Path('nonexistent.txt')
>>> print(bool(current_file))
True
>>> print(bool(fake_file))
False

Wildcard Matching

>>> txt_pattern = Path('temp_dir/*.txt')
>>> print(txt_pattern.matches())
['test1.txt', 'test2.txt']
>>> for file in Path('temp_dir/*'):
...     print(file.basename())
data.csv
readme.md
test1.txt
test2.txt

Recent File Finding

>>> pattern = Path('temp_dir/*.txt')
>>> print(pattern.recent())
newest_file.txt
>>> print(pattern.recent(oldest=True))
old_file.txt

Smart File Opening

>>> mypath = Path('data.txt')
>>> with mypath.open('w') as f:
...     f.write('Hello World')
# Creates regular file
>>> compressed_path = Path('data.txt.gz')
>>> # compressed_path.open() would use gzip automatically
# Would automatically handle gzip compression
** Absolute Path Conversion **
>>> rel_path = Path('data/file.txt')
>>> print(abs(rel_path))
root\mooonpy\examples\tools\path_utils\data\file.txt

Todo

__truediv__ __bool__ __abs__ and __iter__ docstrings in config?

basename() → Path

Split Path to filename and extention.

Alias for os.path.basename

Returns:

Path of file

Return type:

Path

Example:

>>> from mooonpy import Path
>>> MyPath = Path('Project/Monomers/DETDA.mol')
>>> print(MyPath.basename())
'DETDA.mol'

dir() → Path

Split Path to directory.

Alias for os.path.dirname.

Returns:

Path to directory

Return type:

Path

Example:

>>> from mooonpy import Path
>>> MyPath = Path('Project/Monomers/DETDA.mol')
>>> print(MyPath.dir())
'Project\Monomers'

ext() → Path

Split Path to just extention.

Alias for os.path.basename and splitext.

Returns:

extention as Path

Return type:

Path

Example:

>>> from mooonpy import Path
>>> MyPath = Path('Project/Monomers/DETDA.mol')
>>> print(MyPath.ext())
'.mol'

classmethod find_prefix(common=None, path=None, add=True) → Path | None

Extract the prefix of path up to and including common, and optionally append it to search_prefixes.

When path is omitted the caller’s __file__ is used automatically, so a script located inside the common directory tree only needs to supply the common directory name. When common is omitted the already-stored search_common is reused, allowing multiple calls for different drives without repeating the directory name.

Parameters:

• common (str or None) – Shared directory name, e.g. 'research'. Omit to reuse search_common (must have been set earlier).

• path (str, Path, or None) – Path containing common as a component. Omit to use the calling script’s __file__ automatically.

• add (bool) – Append the extracted prefix to search_prefixes (default True). Duplicates are skipped.

Returns:

Extracted prefix Path, or None if common was not found in path.

Return type:

Path or None

Example:

>>> # In a script at C:/research/sims/run_001/analysis.py:
>>> Path.find_prefix('research')           # auto-detects C:\research
Path('C:\\research')
>>> Path.find_prefix(path='D:/backups/research/sims/run_001/analysis.py')
Path('D:\\backups\\research')          # reuses search_common='research'

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

locate(recent=None) → Path | None

Locate this path across search_prefixes.

Behaviour depends on recent and whether the path contains a * wildcard:

• recent=None (default) — prefix-order priority

  • No wildcard: return the first prefix for which the exact file exists.

  • Wildcard: return the glob pattern (* kept in place) for the first prefix that has any matches. Pass that result to matches() or iterate over it to expand the files.

• recent=True — return the most recently modified file across all prefixes (wildcards expanded via locate_all()).

• recent=False — return the oldest file across all prefixes.

Naming note: locate avoids shadowing the built-in str.find() method.

Parameters:

recent – None for prefix-order (default), True for newest, False for oldest.

Returns:

Matched Path, or None.

Return type:

Path or None

Example:

>>> Path.search_prefixes = [Path('C:/research'), Path('D:/backups/research')]
>>> Path.search_common   = 'research'
>>> Path('sims/run_001/output.log').locate()
Path('C:\\research\\sims\\run_001\\output.log')
>>> Path('sims/*/output.log').locate()          # returns the pattern
Path('C:\\research\\sims\\*\\output.log')
>>> Path('sims/*/output.log').locate(recent=True)
Path('D:\\backups\\research\\sims\\run_002\\output.log')
>>> Path('sims/*/output.log').locate(recent=False)
Path('C:\\research\\sims\\run_001\\output.log')

locate_all(whitelist_ext=None, blacklist_ext=None) → List[Path]

Return all glob matches of this path across every prefix in search_prefixes.

Wildcards are expanded on each prefix independently, so Path('sims/*/output.log').locate_all() collects every matching file across all configured drives.

Parameters:

• whitelist_ext – If given, only include paths with these extensions.

• blacklist_ext – If given, exclude paths with these extensions.

Returns:

All matching Path objects across all prefixes.

Return type:

List[Path]

Example:

>>> Path.search_prefixes = [Path('C:/research'), Path('D:/backups/research')]
>>> Path.search_common   = 'research'
>>> Path('sims/*/output.log').locate_all()
[Path('C:\\research\\sims\\run_001\\output.log'),
 Path('D:\\backups\\research\\sims\\run_001\\output.log'),
 Path('D:\\backups\\research\\sims\\run_002\\output.log')]

matches(whitelist_ext=None, blacklist_ext=None) → List[Path]

Finds matching paths with a * (asterisk) wildcard character.

Returns:

List of matching Paths

Return type:

List[Path]

Example:

>>> from mooonpy import Path
>>> MyWildcard = Path('*.mol')
>>> print(Path.matches(MyWildcard))
[Path('DETDA.mol'), Path('DEGBF.mol')]

new_ext(ext: str | Path) → Path

Replace extension on a Path with a new extension.

Parameters:

ext (str or Path) – new extension including delimeter.

Returns:

replaced Path

Return type:

Path

Example:

>>> from mooonpy import Path
>>> MyPath = Path('Project/Monomers/DETDA.mol')
>>> print(MyPath.new_ext('.data'))
'Project/Monomers/DETDA.data'

open(mode='r', encoding='utf-8')

Open path with smart_open

Parameters:

• mode (str) – Open mode, usually ‘r’ or ‘a’

• encoding (str) – File encoding

Returns:

opened file as object

Return type:

File Object

Example:

>>> from mooonpy import Path
>>> MyPath = Path('Project/Monomers/DETDA.mol')
>>> MyFileObj = MyPath.open(mode='r')

recent(oldest: bool = False) → Path | None

Find wildcard matches and return the Path of the most recently modified file.

Parameters:

oldest (bool) – Reverses direction and finds least recently modified file.

Returns:

Path of most recently modified file

Return type:

Path

Example:

>>> from mooonpy import Path
>>> MyWildcard = Path('Template_*.lmpmol')
>>> print(Path.recent())
'Template_1_v10_final_realthistime.lmpmol'
>>> print(Path.recent(oldest=True))
'Template_1.lmpmol'

root() → Path

Split Path to filename with no extention.

Alias for os.path.basename and splitext.

Returns:

Path of filename

Return type:

Path

Example:

>>> from mooonpy import Path
>>> MyPath = Path('Project/Monomers/DETDA.mol')
>>> print(MyPath.root())
'DETDA'

search_common = None

search_prefixes = None

swap_prefix(target) → Path | None

Return a new path with this path’s prefix replaced by target.

Strips everything up to and including search_common from self (via _relpath_from_common()), then prepends the chosen prefix.

Parameters:

target (int, str, or Path) – Replacement prefix — either an int index into search_prefixes, or a str/Path value.

Returns:

Rewritten Path, or None if target is an out-of-range integer index.

Return type:

Path or None

Example:

>>> Path.search_prefixes = [Path('C:/research'), Path('D:/backups/research')]
>>> Path.search_common   = 'research'
>>> p = Path('D:/backups/research/sims/run_001/output.log')
>>> p.swap_prefix(0)
Path('C:\\research\\sims\\run_001\\output.log')
>>> p.swap_prefix('D:/backups/research')
Path('D:\\backups\\research\\sims\\run_001\\output.log')

class mooonpy.Thermospace(filename=None, **kwargs)

Bases: ColTable

Class to hold data found in LAMMPS logs. Data is organized into columns

classmethod basic_read(file: Path | str, silence_error_line: bool = False) → Thermospace

join_restart(restart, step_col='Step', restart_step_ind=0, this_step_ind=None)

Appends data from a restarted thermospace to the current one. Uses (step_col, restart_step_ind) as the start of the appended section, and finds the last matching (step_col, this_step_ind) and overwrites after that

step_col is the column used for indexing, defaults to ‘Step’ but ‘v_Time’ may also be used

restart_step_ind = 0 uses 0th index step, and so on this_step_ind = None uses last matching value

sect(sect_string: str | range | list | int | None = None, priority='off') → ColTable

Subpackages

• mooonpy.fitting package
  • Submodules
    • mooonpy.fitting.dihedral module
      • DihedralDist
        • DihedralDist.default_fit_kws
        • DihedralDist.default_limits
        • DihedralDist.fit_mle()
        • DihedralDist.guess_ic()
        • DihedralDist.guess_limit()
        • DihedralDist.make_params()
        • DihedralDist.plot_mode_decomposition()
        • DihedralDist.run_default()
      • multi_symmetric_gaussian()
      • multi_symmetric_von_mises()
      • symmetric_gaussian_periodic()
      • symmetric_von_mises()
    • mooonpy.fitting.fitting module
      • Bilinear
        • Bilinear.guess_ic()
      • CurveFit
        • CurveFit.best_guess()
        • CurveFit.def_limit
        • CurveFit.default_fit_kws
        • CurveFit.fit_model()
        • CurveFit.get_fit_params()
        • CurveFit.guess_ic()
        • CurveFit.guess_limit()
        • CurveFit.make_params()
        • CurveFit.run_default()
      • Linear
    • mooonpy.fitting.hyperbolic module
      • GaussianTurnFit
        • GaussianTurnFit.guess_ic()
        • GaussianTurnFit.guess_limit()
      • HyperbolaFit
        • HyperbolaFit.guess_ic()
        • HyperbolaFit.guess_limit()
• mooonpy.guis package
  • Submodules
    • mooonpy.guis.hw module
      • greeter_msg()
      • hello_world()
• mooonpy.molspace package
  • Subpackages
    • mooonpy.molspace.graph_theory package
      • Submodules
        • mooonpy.molspace.graph_theory.interface module
          • find_cumulative_neighs()
          • generate_graph()
        • mooonpy.molspace.graph_theory.ring_analysis module
          • find_rings()
          • ring_canonical()
  • Submodules
    • mooonpy.molspace.atom_styles module
      • Styles
        • Styles.atom_factory()
        • Styles.atom_fill()
        • Styles.atom_line()
        • Styles.defaults
        • Styles.func_aliases
        • Styles.line_charge()
        • Styles.line_full()
        • Styles.read_charge()
        • Styles.read_full()
        • Styles.styles
        • Styles.update_astyles()
    • mooonpy.molspace.atoms module
      • Atoms
        • Atoms.copy()
        • Atoms.shift()
        • Atoms.wrap()
    • mooonpy.molspace.bonds_from_distances module
      • find()
    • mooonpy.molspace.box module
      • Box
        • Box.frac2pos()
        • Box.get_lengths()
        • Box.get_transformation_matrix()
        • Box.pos2frac()
    • mooonpy.molspace.clusters module
      • Cluster
        • Cluster.composition
        • Cluster.mass
        • Cluster.members
      • Clusters
        • Clusters.assign_clusters()
        • Clusters.compute_clusters()
        • Clusters.compute_info()
        • Clusters.dict()
        • Clusters.mass_dict()
      • first_neighbor()
    • mooonpy.molspace.distance module
      • ADI_from_bonds()
      • BADI_by_type()
      • Domain
      • Pair
      • Pairs
        • Pairs.filter_cutoff()
        • Pairs.update_bonds()
      • domain_decomp_13()
      • pairs_from_bonds()
      • pairs_from_domains()
    • mooonpy.molspace.doc_examples module
      • MainClass1
        • MainClass1.function1()
      • add()
      • butter()
      • divide()
      • latex()
      • multiply()
      • subtract()
      • useful_docstring()
    • mooonpy.molspace.force_field module
      • Coefficients
      • ForceField
        • ForceField.coeffs_factory()
        • ForceField.get_per_line_styles()
      • Parameters
    • mooonpy.molspace.molspace module
      • Molspace
        • Molspace.KE()
        • Molspace.add_type_labels()
        • Molspace.bonds_from_distances()
        • Molspace.compute_ADI()
        • Molspace.compute_BADI_by_type()
        • Molspace.compute_bond_length()
        • Molspace.compute_pairs()
        • Molspace.copy()
        • Molspace.find_cumulative_neighs()
        • Molspace.find_rings()
        • Molspace.generate_graph()
        • Molspace.read_files()
        • Molspace.remove_atoms()
        • Molspace.temp()
        • Molspace.update_atoms()
        • Molspace.update_elements()
        • Molspace.write_files()
    • mooonpy.molspace.periodic_table module
      • Element
      • Elements
        • Elements.element2mass()
        • Elements.element2radii()
        • Elements.mass2element()
    • mooonpy.molspace.reaxff module
      • ReaxFF
        • ReaxFF.BO_average()
        • ReaxFF.correct_BO()
        • ReaxFF.pair_bo_prime()
        • ReaxFF.read()
        • ReaxFF.sort_ele()
    • mooonpy.molspace.rings module
      • Ring
        • Ring.get_CoM()
        • Ring.get_centroid()
        • Ring.reset_ring_image()
      • get_rings()
    • mooonpy.molspace.topology module
      • Angles
        • Angles.angle_factory()
        • Angles.id_get()
        • Angles.id_set()
        • Angles.key_rule()
      • Bonds
        • Bonds.bond_factory()
        • Bonds.id_get()
        • Bonds.id_set()
        • Bonds.key_rule()
      • Dihedrals
        • Dihedrals.dihedral_factory()
        • Dihedrals.id_get()
        • Dihedrals.id_set()
        • Dihedrals.key_rule()
      • Impropers
        • Impropers.id_get()
        • Impropers.id_set()
        • Impropers.improper_factory()
        • Impropers.key_rule()
• mooonpy.programs package
  • Submodules
    • mooonpy.programs.coarse_graining module
      • add_center_atom()
      • coarsen_by_rings()
      • sort_bond_ids()
    • mooonpy.programs.program module
      • ProgramResults
        • ProgramResults.new_log()
        • ProgramResults.to_dict()
        • ProgramResults.to_list()
    • mooonpy.programs.regression_fringe_response module
      • RFR_tensile_analysis()
      • rfr_labeler()
      • rfr_plotter()
• mooonpy.thermospace package
  • Submodules
    • mooonpy.thermospace.plotting module
      • plot_example()
    • mooonpy.thermospace.thermospace module
      • Thermospace
        • Thermospace.basic_read()
        • Thermospace.join_restart()
        • Thermospace.sect()
      • readlog_basic()
• mooonpy.tools package
  • Submodules
    • mooonpy.tools.file_utils module
      • Path
        • Path.basename()
        • Path.dir()
        • Path.ext()
        • Path.find_prefix()
        • Path.format()
        • Path.locate()
        • Path.locate_all()
        • Path.matches()
        • Path.new_ext()
        • Path.open()
        • Path.recent()
        • Path.root()
        • Path.search_common
        • Path.search_prefixes
        • Path.swap_prefix()
      • smart_open()
    • mooonpy.tools.loop_utils module
      • Cartesian
        • Cartesian.generate()
        • Cartesian.generate_list()
        • Cartesian.get_combined_index()
      • CartesianResult
        • CartesianResult.string_format()
      • DimensionEntry
        • DimensionEntry.cart_key
        • DimensionEntry.condition
        • DimensionEntry.iterable
        • DimensionEntry.name
      • DimensionInfo
        • DimensionInfo.base
        • DimensionInfo.conditionals
        • DimensionInfo.parallels
        • DimensionInfo.size
      • IndexInfo
        • IndexInfo.combined
        • IndexInfo.dimensions
        • IndexInfo.global_idx
    • mooonpy.tools.math_utils module
      • HistBins
      • MixingRule
      • aggregate_fun()
      • bilinear()
      • compute_derivative()
      • compute_fringe_slope()
      • edge_tan_intersect()
      • find_peaks_and_minima()
      • find_peaks_and_valleys()
      • first_value_cross()
      • gaussian_quad_turn()
      • gaussian_turn()
      • hyperbola()
    • mooonpy.tools.misc_utils module
      • ColorMap
      • auto_colorbar()
      • calculate_axis_ticks()
      • inc_arrange()
      • reset_axis_limits()
    • mooonpy.tools.signals module
      • butter_lowpass()
      • compute_PSD()
      • data_extension()
      • determine_mirroring_locations()
      • power_to_db()
      • sparse_eye_diff()
      • whitt_smooth()
    • mooonpy.tools.string_utils module
      • is_float()
      • list2digit()
      • string2digit()
    • mooonpy.tools.tables module
      • ArrayTable
        • ArrayTable.col()
        • ArrayTable.headers()
        • ArrayTable.row()
        • ArrayTable.rowcol()
        • ArrayTable.rowlabels()
        • ArrayTable.shape()
      • ColTable
        • ColTable.col()
        • ColTable.headers()
        • ColTable.items()
        • ColTable.keys()
        • ColTable.read_csv()
        • ColTable.row()
        • ColTable.rowcol()
        • ColTable.rowlabels()
        • ColTable.shape()
        • ColTable.values()
      • ListListTable
        • ListListTable.append()
        • ListListTable.col()
        • ListListTable.headers()
        • ListListTable.read_csv()
        • ListListTable.row()
        • ListListTable.rowcol()
        • ListListTable.rowlabels()
        • ListListTable.shape()
      • Table
        • Table.col_fun()
        • Table.console()
        • Table.copy()
        • Table.csv()
        • Table.plot()
        • Table.yield_line()
• mooonpy.xrdspace package
  • Submodules
    • mooonpy.xrdspace.hw module
      • greeter_msg()
      • hello_world()

Submodules

• mooonpy.rcsetup module
  • RCParams
    • RCParams.reset()
    • RCParams.update()