|
| 1 | +Here's a README file based on the provided code: |
| 2 | +``` |
| 3 | +# Monte Carlo Reweight Dihedral Force Constant |
| 4 | +
|
| 5 | +This Python script implements Monte Carlo reweighting of dihedral force constants, primarily for molecular dynamics simulations. The code has been updated for Python 3 compatibility and improved practices. |
| 6 | +
|
| 7 | +## Usage |
| 8 | +
|
| 9 | +1. **Run the Script**: Execute the script using Python 3 with the required command-line arguments. |
| 10 | + |
| 11 | + ```bash |
| 12 | + python3 monte_carlo_reweight.py <run> <thread> <jobid> <f> |
| 13 | + ``` |
| 14 | + |
| 15 | + - `<run>`: Integer representing the run number. |
| 16 | + - `<thread>`: Number of threads to use for parallel execution. |
| 17 | + - `<jobid>`: Integer representing the job ID. |
| 18 | + - `<f>`: String representing the filename. |
| 19 | + |
| 20 | +2. **Input Files**: Ensure the necessary input files are available, including parameters (`parm.parm`), QM data (`<f>.qm`), and CHARMM scripts (`charmm.<jobid>.sh`). |
| 21 | + |
| 22 | +3. **Output**: The script generates parameter files with optimized parameters (`optimized.<f>.<run>.str`) and intermediate parameter files during each iteration of the Monte Carlo simulation. |
| 23 | + |
| 24 | +## Dependencies |
| 25 | + |
| 26 | +- Python 3 |
| 27 | +- `mcsa_module` (Assumed to be updated for Python 3 compatibility) |
| 28 | +- CHARMM (for molecular dynamics simulations) |
| 29 | + |
| 30 | +## Details |
| 31 | + |
| 32 | +- The script performs Monte Carlo simulations to optimize dihedral force constants based on a target function, using NMR data. |
| 33 | +- It utilizes multi-threading to speed up the optimization process. |
| 34 | +- Intermediate parameter files (`tmp.<jobid>.<f>.<run>.<thread>.<istep>.str`) are generated for each iteration of the simulation. |
| 35 | +- The best parameter set (`optimized.<f>.<run>.str`) is saved with the lowest RMSE value. |
| 36 | +- Execution time is displayed at the end of the script. |
| 37 | + |
| 38 | +## License |
| 39 | + |
| 40 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 41 | +``` |
| 42 | +
|
| 43 | +This README provides information on how to use the script, its dependencies, details about the implementation, and licensing information. Feel free to adjust or expand it further based on your needs. |
0 commit comments