PyMSDump 0.1.1__cp38-cp38-win_amd64.whl

PyMSDump/MSTrj.py

@@ -0,0 +1,165 @@
+from PyMSDump_ import TrajLoad
+from enum import IntEnum, auto, unique
+from dataclasses import dataclass
+from typing import Iterator, Union
+import numpy as np
+import sys
+
+"""
+ * Materials Studio .trj use below units:
+ * All times are in ps.
+ * All energies are in kcal mol-1.
+ * All pressure and stress values are in GPa.
+ * All volumes are in Å3.
+ * All coordinates are in Å.
+ * All velocities are in Å ps-1.
+ * All forces are in kcal mol-1 Å-1.
+ * All temperatures are in K.
+ * All logical values are stored as integers (0=FALSE, not 0=TRUE).
+"""
+
+@dataclass
+class Frame:
+    """ A frame structure in a trajectory
+    Attributes:
+        step (int): current step
+        time (float): current time, ps
+        positions (np.ndarray): Atom positions in Å
+        velocities (Union[np.ndarray, None]): Atom velocities in Å ps-1
+        forces (Union[np.ndarray, None]): Atoms forces in kcal mol-1 Å-1
+        box (np.ndarray): The converted lower triangular simulation box (same as .gro but unit is Angstrom)。
+        crystal (np.ndarray): pdb crystal, unit is angle and angstrom
+        ener (np.ndarray): energy information
+        pvol (np.ndarray): pressure and volume information
+        hasV (bool): if has velocity
+        hasF (bool): if has force
+    """
+    step: int
+    time: float
+    positions: np.ndarray
+    velocities: Union[np.ndarray, None]
+    forces: Union[np.ndarray, None]
+    box: np.ndarray
+    crystal: np.ndarray
+    ener: np.ndarray
+    pvol: np.ndarray
+    hasV: bool
+    hasF: bool
+
+@unique
+class EnergyType(IntEnum):
+    Temp=0  # must from 0
+    AvgTemp=auto()
+    TimeStep=auto()
+    InitialTemp=auto()
+    FinalTemp=auto()
+    TotalPE=auto()
+    BondE=auto()
+    AngleE=auto()
+    TorsionE=auto()
+    InversionE=auto()
+    vdWE=auto()
+    ElectrostaticE=auto()
+    HBondE=auto()
+    ConstraintE=auto()
+    UreyBradleyE=auto()
+    ThreeBodyE=auto()
+    TotalCrossTermE=auto()
+    BendBendE=auto()
+    StretchStretchE=auto()
+    StretchBendStretchE=auto()
+    StretchTorsionStretchE=auto()
+    BendTorsionBendE=auto()
+    TorsionBendBendE=auto()
+    SeperatedStretchStretchE=auto()
+    TorsionStretchE=auto()
+    InversionInversionE=auto()
+    UserE=auto()
+    TotalInternalE=auto()
+    TotalNonBondE=auto()
+    AvgTotalPE=auto()
+    AvgBondE=auto()
+    AvgAngleE=auto()
+    AvgTorsionE=auto()
+    AvgInversionE=auto()
+    AvgvdWE=auto()
+    AvgElectrostaticE=auto()
+    AvgHBondE=auto()
+    AvgConstraintE=auto()
+    AvgUreyBradleyE=auto()
+    AvgThreeBodyE=auto()
+    AvgTotalCrossTermE=auto()
+    AvgBendBendE=auto()
+    AvgStretchStretchE=auto()
+    AvgStretchBendStretchE=auto()
+    AvgStretchTorsionStretchE=auto()
+    AvgBendTorsionBendE=auto()
+    AvgTorsionBendBendE=auto()
+    AvgSeperatedStretchStretchE=auto()
+    AvgTorsionStretchE=auto()
+    AvgInversionInversionE=auto()
+    AvgUserE=auto()
+    AvgTotalInternalE=auto()
+    AvgTotalNonBondE=auto()
+    TotalE=auto()
+    TotalKE=auto()
+    AvgTotalE=auto()
+    AvgTotalKE=auto()
+
+@unique
+class PressVolType(IntEnum):
+    Press = 0   # must from 0
+    Volume=auto()
+    TotalPV=auto()
+    KineticStrsPV=auto()
+    PotentialStrsPV=auto()
+    GyrationRadius=auto()
+    AvgPress=auto()
+    AvgVolume=auto()
+    AvgTotalPV=auto()
+    AvgKineticStrsPV=auto()
+    AvgPotentialStrsPV=auto()
+    AvgGyrationRadius=auto()
+
+class MSTrjReader:
+    def __init__(self, ftrj:str, fpdb:str):
+        self.trajectory = TrajLoad(ftrj, fpdb)
+        self.natoms_ = self.__natoms()
+        self.nframes_ = self.__len__()
+        
+    def __natoms(self):
+        nat = 0
+        for fr in self:
+            nat = len(fr.positions)
+            break
+        return  nat
+    
+    def __iter__(self) -> Iterator[Frame]:
+        try:
+            for _ in self.trajectory:
+                yield _
+        finally:
+            # always reset pointer to header, such for and break
+            self.trajectory.reset()
+
+    def __len__(self):
+        return len([_ for _ in self.trajectory])
+    
+    def __str__(self):
+        return  f'Total frames: {len(self)}'
+    
+    @property  
+    def nframes(self):
+        """ @brief Total number of frames """
+        return self.nframes_
+    
+    @property    
+    def natoms(self):
+        """ @brief Number of atoms in the trajectory """
+        return self.natoms_
+    
+
+if __name__ == '__main__':
+    trj = MSTrjReader(sys.argv[1], sys.argv[2])
+    for ts in trj:
+        print(ts)

pymsdump-0.1.1.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: PyMSDump
+Version: 0.1.1
+Summary: A parser for Materials Studio .trj format
+Author: YujieLiu
+Author-email: 
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: C++
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+
+**<font size=5> A tool to export common trajectory file from Materials Studio</font>**
+
+
+
+# Features
+
+* Support full periodic boundary conditions
+
+  > Please note that this tool has converted the coordinates to match the PDB unit cell and coordinates exported by MS, so there may be differences from the original data output by Perl/Trj2Ascii, especially for the triclinic system.
+
+* Support export move + fix atoms if exist `.pdb`
+
+* Support export `xyz` trajectory file
+
+* Support export `xtc` of gromacs file (includes time and step)
+
+* Support export `.trr` format which contains velocities (`nm/ps`) and forces`(kJ/mol/nm)` if it exists
+
+  > Note that fixed atoms will have zero velocity and force, meaning their coordinates/velocity/force data won't appear in the `.trj` file.
+
+* Support export `.txt` format (`Plain text file`) which contains all kinds of energy items and others:
+
+  ```
+  #Time(ps) Temperature(K) Potential(kJ/mol) Kinetic(KJ/mol) TotalEnergy(KJ/mol) Pressure(bar) Volume(A^3)
+  ```
+* Support Python API
+  ```
+  pip install PyMSDump
+  ```
+  Usage reference: [api_test](https://github.com/liuyujie714/MS_Trajdump/blob/master/PyMSDump/api_test.py)
+  
+
+# Usage
+
+First locate molecular dynamics trajectory file created by `Materials Studio`, hidden file `.trj`  and `.xtd` are located in same folder.
+
+
+
+Then download program from here: [Download](https://github.com/liuyujie714/MS_Trajdump/releases)
+
+
+
+
+* Linux
+
+  ```
+  chmod a+x MS_dump
+  ./MS_dump -s system.pdb -f system.trj
+  ```
+
+* Windows
+
+  ```
+  .\MS_dump.exe -s system.pdb -f system.trj
+  ```
+
+
+
+Default output `MS_traj.xyz`, the comment line has box information that can be read by [Ovito](https://www.ovito.org/)  software directly. 
+
+> Lattice="14.408798 0.0 0.0 0.000000 14.408798 0.0 0.000000 0.000000 14.408798" Properties=species:S:1:pos:R:3
+
+
+
+
+
+**Note:**
+
+> The exported xyz will use `C` name for all atoms if not provide pdb file, such as:
+>
+> ```
+> .\MS_dump.exe -f system.trj
+> ```
+
+
+
+
+
+`-o` option can control output format
+
+
+
+If you want to export `.xtc/.trr` of gromacs, use command:
+
+```
+.\MS_dump.exe -s system.pdb -f system.trj -o system.xtc
+```
+
+```
+.\MS_dump.exe -s system.pdb -f system.trj -o system.trr
+```
+
+
+
+Also export energy items:
+
+```
+.\MS_dump.exe -f system.trj -o energy.txt
+```
+

pymsdump-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+PyMSDump_.cp38-win_amd64.pyd,sha256=WYJGWPMYx6vvCIRTk6hsRcreDPJNYE-Q15S0qtwhLno,272384
+PyMSDump/MSTrj.py,sha256=Iuw2C38W7S2rVlfBEPiEnlxBPwsbSdnvtZhQYDtZTCQ,4571
+PyMSDump/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pymsdump-0.1.1.dist-info/METADATA,sha256=uItE3svXqmB5e32OwNvMNqTN60cjXHTs7zPUYT5Hutg,2756
+pymsdump-0.1.1.dist-info/WHEEL,sha256=TFndZn0SXD1XqMUEIKDojL47weLF1ldHBOPnF9B_sLo,99
+pymsdump-0.1.1.dist-info/top_level.txt,sha256=0kBKWZ5c4yBR5LA0ZRXz4oo5CqDSVpTyPZ6jiNzuMiY,19
+pymsdump-0.1.1.dist-info/RECORD,,

pymsdump-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.3.4)
+Root-Is-Purelib: false
+Tag: cp38-cp38-win_amd64
+

pymsdump-0.1.1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+PyMSDump
+PyMSDump_