update the function of get_forcefield

doc/Installation.rst

@@ -53,7 +53,7 @@ or make a copy of the source code, and then install it manually.
 
     $ git clone https://github.com/qzhu2017/pyxtal
     $ cd pyxtal
-    $ python setup.py install
+    $ pip install .
 
 
 or update the code to our developing version

pyxtal/__init__.py

@@ -3002,7 +3002,7 @@ def to_atomic_xtal(self):
 
 
     def get_forcefield(self, ff_style='openff', code='lammps',
-                       chargemethod='am1bcc'):
+                       chargemethod='am1bcc', parameters=None):
         """
         An interface to create forcefield for molecular simulation with
         - Charmm
@@ -3014,6 +3014,7 @@ def get_forcefield(self, ff_style='openff', code='lammps',
             - ff_style: 'gaff' or 'openff'
             - code: 'lammps' or 'charmm'
             - charge_method: 'am1bcc', 'am1-mulliken', 'mmff94', 'gasteiger'
+            - parameters: 1D-array of user-specified FF parameters
 
         Returns:
             An ase_atoms_objects with force field information
@@ -3055,6 +3056,10 @@ def get_forcefield(self, ff_style='openff', code='lammps',
             # Initialize the forcefield instance from ost
             ff = forcefield(smiles, style=ff_style, chargemethod=chargemethod)
 
+            # update the parameters from the user
+            if parameters is not None:
+                ff.update_parameters(parameters)
+
             # Create the Parmed to handle FF parameters
             if sum(n_mols) == 1:
                 pd_struc = ff.molecules[0].copy(cls=ParmEdStructure)

requirements.txt

@@ -5,3 +5,4 @@ networkx>=2.3
 scipy>=1.7.3
 importlib_metadata>=1.4
 ase>=3.18.0
+monty==2023.11.3

scripts/pyxtal_main.py

@@ -140,7 +140,7 @@
             rand_crystal.from_random(3, sg, system, numIons0, factor, conventional=conventional)
         elif dimension == 2:
             rand_crystal.from_random(2, sg, system, numIons0, factor, thickness, conventional=conventional)
-        elif dimension == 1:                                             
+        elif dimension == 1:
             rand_crystal.from_random(1, sg, system, numIons0, factor, thickness, conventional=conventional)
         if dimension == 0:
             rand_crystal.from_random(0, sg, system, numIons0, factor)