packmol-memgen-minimal 1.1.16__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. packmol_memgen/__init__.py +2 -0
  2. packmol_memgen/__version__.py +34 -0
  3. packmol_memgen/data/LICENSE.Apache-2.0 +201 -0
  4. packmol_memgen/data/extra_solvents.lib +789 -0
  5. packmol_memgen/data/frcmod.lipid_ext +97 -0
  6. packmol_memgen/data/frcmod.solvents +129 -0
  7. packmol_memgen/data/insane_lipids.txt +138 -0
  8. packmol_memgen/data/insane_solvents.txt +45 -0
  9. packmol_memgen/data/leaprc.extra_solvents +42 -0
  10. packmol_memgen/data/leaprc.lipid_ext +48 -0
  11. packmol_memgen/data/lipid_ext.lib +12312 -0
  12. packmol_memgen/data/martini_v3.0.0.itp +356605 -0
  13. packmol_memgen/data/memgen.parm +4082 -0
  14. packmol_memgen/data/pdbs.tar.gz +0 -0
  15. packmol_memgen/data/solvent.parm +14 -0
  16. packmol_memgen/example/example.sh +31 -0
  17. packmol_memgen/lib/__init__.py +0 -0
  18. packmol_memgen/lib/amber.py +77 -0
  19. packmol_memgen/lib/charmmlipid2amber/__init__.py +0 -0
  20. packmol_memgen/lib/charmmlipid2amber/charmmlipid2amber.csv +7164 -0
  21. packmol_memgen/lib/charmmlipid2amber/charmmlipid2amber.py +225 -0
  22. packmol_memgen/lib/pdbremix/LICENSE +21 -0
  23. packmol_memgen/lib/pdbremix/__init__.py +0 -0
  24. packmol_memgen/lib/pdbremix/_version.py +1 -0
  25. packmol_memgen/lib/pdbremix/amber.py +1103 -0
  26. packmol_memgen/lib/pdbremix/asa.py +227 -0
  27. packmol_memgen/lib/pdbremix/data/aminoacid.pdb +334 -0
  28. packmol_memgen/lib/pdbremix/data/binaries.json +26 -0
  29. packmol_memgen/lib/pdbremix/data/charmm22.parameter +2250 -0
  30. packmol_memgen/lib/pdbremix/data/charmm22.topology +1635 -0
  31. packmol_memgen/lib/pdbremix/data/color_b.py +682 -0
  32. packmol_memgen/lib/pdbremix/data/hin.lib +130 -0
  33. packmol_memgen/lib/pdbremix/data/hydroxide.lib +88 -0
  34. packmol_memgen/lib/pdbremix/data/make_chi.py +92 -0
  35. packmol_memgen/lib/pdbremix/data/opls.parameter +1108 -0
  36. packmol_memgen/lib/pdbremix/data/opls.topology +1869 -0
  37. packmol_memgen/lib/pdbremix/data/phd.frcmod +82 -0
  38. packmol_memgen/lib/pdbremix/data/phd.leaprc +4 -0
  39. packmol_memgen/lib/pdbremix/data/phd.prepin +35 -0
  40. packmol_memgen/lib/pdbremix/data/template.pdb +334 -0
  41. packmol_memgen/lib/pdbremix/data/znb.frcmod +24 -0
  42. packmol_memgen/lib/pdbremix/data/znb.leaprc +7 -0
  43. packmol_memgen/lib/pdbremix/data/znb.lib +69 -0
  44. packmol_memgen/lib/pdbremix/data.py +264 -0
  45. packmol_memgen/lib/pdbremix/fetch.py +102 -0
  46. packmol_memgen/lib/pdbremix/force.py +627 -0
  47. packmol_memgen/lib/pdbremix/gromacs.py +978 -0
  48. packmol_memgen/lib/pdbremix/lib/__init__.py +0 -0
  49. packmol_memgen/lib/pdbremix/lib/docopt.py +579 -0
  50. packmol_memgen/lib/pdbremix/lib/pyqcprot.py +305 -0
  51. packmol_memgen/lib/pdbremix/namd.py +1078 -0
  52. packmol_memgen/lib/pdbremix/pdbatoms.py +543 -0
  53. packmol_memgen/lib/pdbremix/pdbtext.py +120 -0
  54. packmol_memgen/lib/pdbremix/protein.py +311 -0
  55. packmol_memgen/lib/pdbremix/pymol.py +480 -0
  56. packmol_memgen/lib/pdbremix/rmsd.py +203 -0
  57. packmol_memgen/lib/pdbremix/simulate.py +420 -0
  58. packmol_memgen/lib/pdbremix/spacehash.py +73 -0
  59. packmol_memgen/lib/pdbremix/trajectory.py +286 -0
  60. packmol_memgen/lib/pdbremix/util.py +273 -0
  61. packmol_memgen/lib/pdbremix/v3.py +16 -0
  62. packmol_memgen/lib/pdbremix/v3array.py +482 -0
  63. packmol_memgen/lib/pdbremix/v3numpy.py +350 -0
  64. packmol_memgen/lib/pdbremix/volume.py +155 -0
  65. packmol_memgen/lib/utils.py +1017 -0
  66. packmol_memgen/main.py +2827 -0
  67. packmol_memgen_minimal-1.1.16.dist-info/METADATA +664 -0
  68. packmol_memgen_minimal-1.1.16.dist-info/RECORD +71 -0
  69. packmol_memgen_minimal-1.1.16.dist-info/WHEEL +4 -0
  70. packmol_memgen_minimal-1.1.16.dist-info/entry_points.txt +2 -0
  71. packmol_memgen_minimal-1.1.16.dist-info/licenses/LICENSE +338 -0
@@ -0,0 +1,664 @@
1
+ Metadata-Version: 2.4
2
+ Name: packmol-memgen-minimal
3
+ Version: 1.1.16
4
+ Summary: A fork of packmol_memgen from AmberTools, a PACKMOL wrapper for packing proteins into membranes, aimed to be minimal, mordernized and self-contained.
5
+ Project-URL: Homepage, https://github.com/xiaoxuan-yu/packmol_memgen_minimal/
6
+ Author-email: Xiaoxuan Yu <xiaoxuan_yu@pku.edu.cn>
7
+ License: GNU GENERAL PUBLIC LICENSE
8
+ Version 2, June 1991
9
+
10
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
11
+ <https://fsf.org/>
12
+ Everyone is permitted to copy and distribute verbatim copies
13
+ of this license document, but changing it is not allowed.
14
+
15
+ Preamble
16
+
17
+ The licenses for most software are designed to take away your
18
+ freedom to share and change it. By contrast, the GNU General Public
19
+ License is intended to guarantee your freedom to share and change free
20
+ software--to make sure the software is free for all its users. This
21
+ General Public License applies to most of the Free Software
22
+ Foundation's software and to any other program whose authors commit to
23
+ using it. (Some other Free Software Foundation software is covered by
24
+ the GNU Lesser General Public License instead.) You can apply it to
25
+ your programs, too.
26
+
27
+ When we speak of free software, we are referring to freedom, not
28
+ price. Our General Public Licenses are designed to make sure that you
29
+ have the freedom to distribute copies of free software (and charge for
30
+ this service if you wish), that you receive source code or can get it
31
+ if you want it, that you can change the software or use pieces of it
32
+ in new free programs; and that you know you can do these things.
33
+
34
+ To protect your rights, we need to make restrictions that forbid
35
+ anyone to deny you these rights or to ask you to surrender the rights.
36
+ These restrictions translate to certain responsibilities for you if you
37
+ distribute copies of the software, or if you modify it.
38
+
39
+ For example, if you distribute copies of such a program, whether
40
+ gratis or for a fee, you must give the recipients all the rights that
41
+ you have. You must make sure that they, too, receive or can get the
42
+ source code. And you must show them these terms so they know their
43
+ rights.
44
+
45
+ We protect your rights with two steps: (1) copyright the software, and
46
+ (2) offer you this license which gives you legal permission to copy,
47
+ distribute and/or modify the software.
48
+
49
+ Also, for each author's protection and ours, we want to make certain
50
+ that everyone understands that there is no warranty for this free
51
+ software. If the software is modified by someone else and passed on, we
52
+ want its recipients to know that what they have is not the original, so
53
+ that any problems introduced by others will not reflect on the original
54
+ authors' reputations.
55
+
56
+ Finally, any free program is threatened constantly by software
57
+ patents. We wish to avoid the danger that redistributors of a free
58
+ program will individually obtain patent licenses, in effect making the
59
+ program proprietary. To prevent this, we have made it clear that any
60
+ patent must be licensed for everyone's free use or not licensed at all.
61
+
62
+ The precise terms and conditions for copying, distribution and
63
+ modification follow.
64
+
65
+ GNU GENERAL PUBLIC LICENSE
66
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
67
+
68
+ 0. This License applies to any program or other work which contains
69
+ a notice placed by the copyright holder saying it may be distributed
70
+ under the terms of this General Public License. The "Program", below,
71
+ refers to any such program or work, and a "work based on the Program"
72
+ means either the Program or any derivative work under copyright law:
73
+ that is to say, a work containing the Program or a portion of it,
74
+ either verbatim or with modifications and/or translated into another
75
+ language. (Hereinafter, translation is included without limitation in
76
+ the term "modification".) Each licensee is addressed as "you".
77
+
78
+ Activities other than copying, distribution and modification are not
79
+ covered by this License; they are outside its scope. The act of
80
+ running the Program is not restricted, and the output from the Program
81
+ is covered only if its contents constitute a work based on the
82
+ Program (independent of having been made by running the Program).
83
+ Whether that is true depends on what the Program does.
84
+
85
+ 1. You may copy and distribute verbatim copies of the Program's
86
+ source code as you receive it, in any medium, provided that you
87
+ conspicuously and appropriately publish on each copy an appropriate
88
+ copyright notice and disclaimer of warranty; keep intact all the
89
+ notices that refer to this License and to the absence of any warranty;
90
+ and give any other recipients of the Program a copy of this License
91
+ along with the Program.
92
+
93
+ You may charge a fee for the physical act of transferring a copy, and
94
+ you may at your option offer warranty protection in exchange for a fee.
95
+
96
+ 2. You may modify your copy or copies of the Program or any portion
97
+ of it, thus forming a work based on the Program, and copy and
98
+ distribute such modifications or work under the terms of Section 1
99
+ above, provided that you also meet all of these conditions:
100
+
101
+ a) You must cause the modified files to carry prominent notices
102
+ stating that you changed the files and the date of any change.
103
+
104
+ b) You must cause any work that you distribute or publish, that in
105
+ whole or in part contains or is derived from the Program or any
106
+ part thereof, to be licensed as a whole at no charge to all third
107
+ parties under the terms of this License.
108
+
109
+ c) If the modified program normally reads commands interactively
110
+ when run, you must cause it, when started running for such
111
+ interactive use in the most ordinary way, to print or display an
112
+ announcement including an appropriate copyright notice and a
113
+ notice that there is no warranty (or else, saying that you provide
114
+ a warranty) and that users may redistribute the program under
115
+ these conditions, and telling the user how to view a copy of this
116
+ License. (Exception: if the Program itself is interactive but
117
+ does not normally print such an announcement, your work based on
118
+ the Program is not required to print an announcement.)
119
+
120
+ These requirements apply to the modified work as a whole. If
121
+ identifiable sections of that work are not derived from the Program,
122
+ and can be reasonably considered independent and separate works in
123
+ themselves, then this License, and its terms, do not apply to those
124
+ sections when you distribute them as separate works. But when you
125
+ distribute the same sections as part of a whole which is a work based
126
+ on the Program, the distribution of the whole must be on the terms of
127
+ this License, whose permissions for other licensees extend to the
128
+ entire whole, and thus to each and every part regardless of who wrote it.
129
+
130
+ Thus, it is not the intent of this section to claim rights or contest
131
+ your rights to work written entirely by you; rather, the intent is to
132
+ exercise the right to control the distribution of derivative or
133
+ collective works based on the Program.
134
+
135
+ In addition, mere aggregation of another work not based on the Program
136
+ with the Program (or with a work based on the Program) on a volume of
137
+ a storage or distribution medium does not bring the other work under
138
+ the scope of this License.
139
+
140
+ 3. You may copy and distribute the Program (or a work based on it,
141
+ under Section 2) in object code or executable form under the terms of
142
+ Sections 1 and 2 above provided that you also do one of the following:
143
+
144
+ a) Accompany it with the complete corresponding machine-readable
145
+ source code, which must be distributed under the terms of Sections
146
+ 1 and 2 above on a medium customarily used for software interchange; or,
147
+
148
+ b) Accompany it with a written offer, valid for at least three
149
+ years, to give any third party, for a charge no more than your
150
+ cost of physically performing source distribution, a complete
151
+ machine-readable copy of the corresponding source code, to be
152
+ distributed under the terms of Sections 1 and 2 above on a medium
153
+ customarily used for software interchange; or,
154
+
155
+ c) Accompany it with the information you received as to the offer
156
+ to distribute corresponding source code. (This alternative is
157
+ allowed only for noncommercial distribution and only if you
158
+ received the program in object code or executable form with such
159
+ an offer, in accord with Subsection b above.)
160
+
161
+ The source code for a work means the preferred form of the work for
162
+ making modifications to it. For an executable work, complete source
163
+ code means all the source code for all modules it contains, plus any
164
+ associated interface definition files, plus the scripts used to
165
+ control compilation and installation of the executable. However, as a
166
+ special exception, the source code distributed need not include
167
+ anything that is normally distributed (in either source or binary
168
+ form) with the major components (compiler, kernel, and so on) of the
169
+ operating system on which the executable runs, unless that component
170
+ itself accompanies the executable.
171
+
172
+ If distribution of executable or object code is made by offering
173
+ access to copy from a designated place, then offering equivalent
174
+ access to copy the source code from the same place counts as
175
+ distribution of the source code, even though third parties are not
176
+ compelled to copy the source along with the object code.
177
+
178
+ 4. You may not copy, modify, sublicense, or distribute the Program
179
+ except as expressly provided under this License. Any attempt
180
+ otherwise to copy, modify, sublicense or distribute the Program is
181
+ void, and will automatically terminate your rights under this License.
182
+ However, parties who have received copies, or rights, from you under
183
+ this License will not have their licenses terminated so long as such
184
+ parties remain in full compliance.
185
+
186
+ 5. You are not required to accept this License, since you have not
187
+ signed it. However, nothing else grants you permission to modify or
188
+ distribute the Program or its derivative works. These actions are
189
+ prohibited by law if you do not accept this License. Therefore, by
190
+ modifying or distributing the Program (or any work based on the
191
+ Program), you indicate your acceptance of this License to do so, and
192
+ all its terms and conditions for copying, distributing or modifying
193
+ the Program or works based on it.
194
+
195
+ 6. Each time you redistribute the Program (or any work based on the
196
+ Program), the recipient automatically receives a license from the
197
+ original licensor to copy, distribute or modify the Program subject to
198
+ these terms and conditions. You may not impose any further
199
+ restrictions on the recipients' exercise of the rights granted herein.
200
+ You are not responsible for enforcing compliance by third parties to
201
+ this License.
202
+
203
+ 7. If, as a consequence of a court judgment or allegation of patent
204
+ infringement or for any other reason (not limited to patent issues),
205
+ conditions are imposed on you (whether by court order, agreement or
206
+ otherwise) that contradict the conditions of this License, they do not
207
+ excuse you from the conditions of this License. If you cannot
208
+ distribute so as to satisfy simultaneously your obligations under this
209
+ License and any other pertinent obligations, then as a consequence you
210
+ may not distribute the Program at all. For example, if a patent
211
+ license would not permit royalty-free redistribution of the Program by
212
+ all those who receive copies directly or indirectly through you, then
213
+ the only way you could satisfy both it and this License would be to
214
+ refrain entirely from distribution of the Program.
215
+
216
+ If any portion of this section is held invalid or unenforceable under
217
+ any particular circumstance, the balance of the section is intended to
218
+ apply and the section as a whole is intended to apply in other
219
+ circumstances.
220
+
221
+ It is not the purpose of this section to induce you to infringe any
222
+ patents or other property right claims or to contest validity of any
223
+ such claims; this section has the sole purpose of protecting the
224
+ integrity of the free software distribution system, which is
225
+ implemented by public license practices. Many people have made
226
+ generous contributions to the wide range of software distributed
227
+ through that system in reliance on consistent application of that
228
+ system; it is up to the author/donor to decide if he or she is willing
229
+ to distribute software through any other system and a licensee cannot
230
+ impose that choice.
231
+
232
+ This section is intended to make thoroughly clear what is believed to
233
+ be a consequence of the rest of this License.
234
+
235
+ 8. If the distribution and/or use of the Program is restricted in
236
+ certain countries either by patents or by copyrighted interfaces, the
237
+ original copyright holder who places the Program under this License
238
+ may add an explicit geographical distribution limitation excluding
239
+ those countries, so that distribution is permitted only in or among
240
+ countries not thus excluded. In such case, this License incorporates
241
+ the limitation as if written in the body of this License.
242
+
243
+ 9. The Free Software Foundation may publish revised and/or new versions
244
+ of the General Public License from time to time. Such new versions will
245
+ be similar in spirit to the present version, but may differ in detail to
246
+ address new problems or concerns.
247
+
248
+ Each version is given a distinguishing version number. If the Program
249
+ specifies a version number of this License which applies to it and "any
250
+ later version", you have the option of following the terms and conditions
251
+ either of that version or of any later version published by the Free
252
+ Software Foundation. If the Program does not specify a version number of
253
+ this License, you may choose any version ever published by the Free Software
254
+ Foundation.
255
+
256
+ 10. If you wish to incorporate parts of the Program into other free
257
+ programs whose distribution conditions are different, write to the author
258
+ to ask for permission. For software which is copyrighted by the Free
259
+ Software Foundation, write to the Free Software Foundation; we sometimes
260
+ make exceptions for this. Our decision will be guided by the two goals
261
+ of preserving the free status of all derivatives of our free software and
262
+ of promoting the sharing and reuse of software generally.
263
+
264
+ NO WARRANTY
265
+
266
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
267
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
268
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
269
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
270
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
271
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
272
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
273
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
274
+ REPAIR OR CORRECTION.
275
+
276
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
277
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
278
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
279
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
280
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
281
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
282
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
283
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
284
+ POSSIBILITY OF SUCH DAMAGES.
285
+
286
+ END OF TERMS AND CONDITIONS
287
+
288
+ How to Apply These Terms to Your New Programs
289
+
290
+ If you develop a new program, and you want it to be of the greatest
291
+ possible use to the public, the best way to achieve this is to make it
292
+ free software which everyone can redistribute and change under these terms.
293
+
294
+ To do so, attach the following notices to the program. It is safest
295
+ to attach them to the start of each source file to most effectively
296
+ convey the exclusion of warranty; and each file should have at least
297
+ the "copyright" line and a pointer to where the full notice is found.
298
+
299
+ <one line to give the program's name and a brief idea of what it does.>
300
+ Copyright (C) <year> <name of author>
301
+
302
+ This program is free software; you can redistribute it and/or modify
303
+ it under the terms of the GNU General Public License as published by
304
+ the Free Software Foundation; either version 2 of the License, or
305
+ (at your option) any later version.
306
+
307
+ This program is distributed in the hope that it will be useful,
308
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
309
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
310
+ GNU General Public License for more details.
311
+
312
+ You should have received a copy of the GNU General Public License along
313
+ with this program; if not, see <https://www.gnu.org/licenses/>.
314
+
315
+ Also add information on how to contact you by electronic and paper mail.
316
+
317
+ If the program is interactive, make it output a short notice like this
318
+ when it starts in an interactive mode:
319
+
320
+ Gnomovision version 69, Copyright (C) year name of author
321
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
322
+ This is free software, and you are welcome to redistribute it
323
+ under certain conditions; type `show c' for details.
324
+
325
+ The hypothetical commands `show w' and `show c' should show the appropriate
326
+ parts of the General Public License. Of course, the commands you use may
327
+ be called something other than `show w' and `show c'; they could even be
328
+ mouse-clicks or menu items--whatever suits your program.
329
+
330
+ You should also get your employer (if you work as a programmer) or your
331
+ school, if any, to sign a "copyright disclaimer" for the program, if
332
+ necessary. Here is a sample; alter the names:
333
+
334
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
335
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
336
+
337
+ <signature of Moe Ghoul>, 1 April 1989
338
+ Moe Ghoul, President of Vice
339
+
340
+ This General Public License does not permit incorporating your program into
341
+ proprietary programs. If your program is a subroutine library, you may
342
+ consider it more useful to permit linking proprietary applications with the
343
+ library. If this is what you want to do, use the GNU Lesser General
344
+ Public License instead of this License.
345
+ License-File: LICENSE
346
+ Classifier: Development Status :: 3 - Alpha
347
+ Classifier: Intended Audience :: Science/Research
348
+ Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
349
+ Classifier: Programming Language :: Python
350
+ Classifier: Programming Language :: Python :: 3
351
+ Classifier: Topic :: Scientific/Engineering
352
+ Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
353
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
354
+ Requires-Python: >=3.11
355
+ Requires-Dist: hatch-vcs>=0.5.0
356
+ Requires-Dist: matplotlib
357
+ Requires-Dist: numpy
358
+ Requires-Dist: pandas
359
+ Requires-Dist: pdb2pqr>=3.7.1
360
+ Requires-Dist: scipy
361
+ Requires-Dist: tqdm
362
+ Provides-Extra: full
363
+ Requires-Dist: mdtraj; extra == 'full'
364
+ Requires-Dist: mempro; extra == 'full'
365
+ Requires-Dist: packmol; extra == 'full'
366
+ Requires-Dist: vermouth; extra == 'full'
367
+ Provides-Extra: martini
368
+ Requires-Dist: mdtraj; extra == 'martini'
369
+ Requires-Dist: vermouth; extra == 'martini'
370
+ Provides-Extra: mempro
371
+ Requires-Dist: mempro; extra == 'mempro'
372
+ Provides-Extra: packmol
373
+ Requires-Dist: packmol; extra == 'packmol'
374
+ Description-Content-Type: text/x-rst
375
+
376
+ #############################################################
377
+ PACKMOL MEMGEN MINIMAL 2026.1.8
378
+ #############################################################
379
+ Xiaoxuan Yu
380
+ 2026-01-08
381
+
382
+ ################
383
+ THIS FORK NOTES
384
+ ################
385
+
386
+ This repository is a fork of packmol-memgen. The original README content is
387
+ preserved below; this section summarizes the changes and current behavior.
388
+
389
+ - Packaging: this fork is published on PyPI (sdist/wheel). The Python wheel aims to
390
+ avoid system-level dependencies (e.g., no AmberTools requirement). Some features
391
+ include SIRAH coarse-graining support, minimization, parametrization and protonation
392
+ using reduce are not available in this fork.
393
+
394
+ - Packmol: packing is performed by the external PACKMOL command-line tool. This
395
+ package does not bundle PACKMOL; it is expected to be available on PATH. For
396
+ convenience, it can be installed via an optional dependency (extra).
397
+
398
+ - Membrane orientation: membrane alignment/orientation is performed via MemPrO
399
+ (Python + JAX) instead of the upstream memembed/ppm3 workflow. MemPrO is invoked
400
+ via subprocess as an external command-line tool. MemPrO is not bundled into this
401
+ package but can be installed via an optional dependency for convenience.
402
+
403
+ - Protonation: protonation uses pdb2pqr when needed.
404
+ - Output location: use ``--outdir DIR`` to write all generated files (final ``--output``, ``--log``, ``--packlog`` scripts/logs, intermediate structures) into a single directory.
405
+
406
+ ###########################################
407
+ Martini Auto-Mapping (MemPrO/Insane4MemPrO)
408
+ ###########################################
409
+
410
+ When ``--martini`` is enabled, the script can auto-build ``--insane_args`` for
411
+ MemPrO/Insane4MemPrO with the following behavior:
412
+
413
+ - Lipids: ``--lipids`` + ``--ratio`` map to Insane ``-l/-u``. ``//`` syntax is
414
+ supported for lower/upper leaflets. Two ``--lipids`` entries are supported and
415
+ map to Insane ``-l/-u`` (inner membrane) and ``-lo/-uo`` (outer membrane).
416
+ - Box size: ``--dims`` is converted from Angstrom to nm and passed as ``-x/-y/-z``.
417
+ - Curvature: ``--curvature`` or ``--curv_radius`` maps to ``-curv c0,0,dir``
418
+ where ``c0 = abs(curvature)``, ``dir = sign(curvature)``.
419
+ - Solvents: ``--solvents`` + ``--solvent_ratio`` map to ``-sol`` entries. The
420
+ only automatic name mapping is ``WAT -> W``, which emits a warning once. All
421
+ other solvent names must match Insane solventParticles (see
422
+ ``packmol_memgen/data/insane_solvents.txt``).
423
+ - Salts: ``--salt``, ``--salt_c``, ``--salt_a`` map to ``-posi_c0/1/2`` and
424
+ ``-negi_c0/1/2`` using ion tokens stripped to letters (e.g. ``Na+`` -> ``NA``).
425
+ ``--saltcon`` maps to ``-ion_conc`` with the value replicated for all three
426
+ compartments.
427
+
428
+ The following options are *not* supported in Martini auto-mapping and will emit
429
+ warnings: ``--distxy_fix``, ``--dist``, ``--dist_wat``, ``--xygauss``,
430
+ ``--apl_offset``, ``--lip_offset``, ``--pbc``, ``--nocounter``,
431
+ ``--charge_imbalance``, ``--imbalance_ion``. You can still supply custom
432
+ ``--insane_args`` to override or extend the auto-generated arguments.
433
+
434
+ ############
435
+ Installation
436
+ ############
437
+ Minimal installation (this fork without PACKMOL or MemPrO):
438
+
439
+ ``pip install packmol-memgen-minimal``
440
+
441
+ With optional packmol as a dependency:
442
+
443
+ ``pip install packmol-memgen-minimal[packmol]``
444
+
445
+ With optional mempro as a dependency:
446
+
447
+ ``pip install packmol-memgen-minimal[mempro]``
448
+
449
+ With both optional dependencies:
450
+
451
+ ``pip install packmol-memgen-minimal[full]``
452
+
453
+ You may prefer mordern Python packaging tools such as `uv` to install
454
+
455
+ ``uv tool install packmol-memgen-minimal``
456
+
457
+ extras are supported in `uv` as well. Other tools may work similarly.
458
+
459
+
460
+ ############
461
+ LICENSE NOTE
462
+ ############
463
+
464
+ This fork is distributed under GPL-2.0-only, inherited from the upstream project.
465
+
466
+ MemPrO is an optional external command-line tool distributed under the GNU GPL v3.
467
+ This project interacts with MemPrO via subprocess calls; MemPrO is not bundled into
468
+ this package and its license applies to MemPrO itself.
469
+
470
+ The martini force field parameter file `packmol_memgen/data/martini_v3.0.0.itp` is
471
+ sourced from https://github.com/Martini-Force-Field-Initiative/martini-forcefields
472
+ and is distributed under the Apache License 2.0. The full Apache 2.0 license text
473
+ is provided at `packmol_memgen/data/LICENSE.Apache-2.0`.
474
+
475
+ ##########
476
+ CREDITS
477
+ ##########
478
+
479
+ This project depends on and/or interoperates with the following open-source
480
+ software. Please refer to each project for license terms.
481
+
482
+ Core dependencies (installed via PyPI):
483
+
484
+ - NumPy (https://github.com/numpy/numpy)
485
+ - SciPy (https://github.com/scipy/scipy)
486
+ - pandas (https://github.com/pandas-dev/pandas)
487
+ - tqdm (https://github.com/tqdm/tqdm)
488
+ - matplotlib (https://github.com/matplotlib/matplotlib)
489
+ - PDB2PQR (https://github.com/Electrostatics/pdb2pqr)
490
+ - docopt (https://github.com/docopt/docopt)
491
+
492
+ Optional external tools (installed separately; invoked via subprocess):
493
+
494
+ - PACKMOL (MIT License, https://github.com/m3g/packmol)
495
+ - MemPrO (GNU GPL v3, https://github.com/ShufflerBardOnTheEdge/MemPrO)
496
+
497
+ Additional utilities used by this workflow:
498
+
499
+ - PDBREMIX (MIT License, https://github.com/boscoh/pdbremix)
500
+ - charmmlipid2amber (GPL-2.0, from `AmberTools 2025`, https://ambermd.org/AmberTools.php)
501
+ - Martini 3 force field parameters (Apache-2.0, https://github.com/Martini-Force-Field-Initiative/martini-forcefields)
502
+
503
+
504
+ #############################################################
505
+ PACKMOL MEMGEN 2023.8.8
506
+ #############################################################
507
+ Stephan N. Schott V.
508
+ 2016-11-07
509
+
510
+
511
+
512
+ ############
513
+ INSTALLATION
514
+ ############
515
+
516
+ The main installation of Packmol Memgen is intended to be installed within AmberTools20. If that is not the case
517
+ the following instructions could be follow to make it run as a stand-alone, though it is not officially supported.
518
+
519
+ Dependencies:
520
+ Boost (tested with 1.54 or above)
521
+ gfortran & gcc (tested with 4.8 and above)
522
+ python 2.7 (or above)
523
+
524
+ The script should work as is. Includes a setup.py script which should work as usual:
525
+
526
+ ``python setup.py install``
527
+
528
+ or
529
+
530
+ ``pip install .``
531
+
532
+ You can specify a custom installation location with --home=<FOLDER> or --prefix=<FOLDER>, respectively.
533
+ Testing of the software can be performed in the example folder, by executing "./example.sh".
534
+ This folder can be easily cleaned by executing "./example.sh clean"
535
+
536
+
537
+
538
+ ##############
539
+ CHANGELOG
540
+ ##############
541
+ 2025.3.22
542
+ - Added initial functionality to support Packmol's PBC option
543
+ 2025.3.17
544
+ - Added onlyleapin flag to generate a template leap input without parametrizing.
545
+ - Modified memembed with Claude 3.7 suggestions to stop using boost.
546
+ - Updated packmol to 20.16
547
+ 2025.2.10
548
+ - Force using propka for titration with_ph in pdb2pqr
549
+ 2025.1.29
550
+ - Bugfix calculating center of PDB. This could have caused issues in calculating volumes, mainly in solvated systems.
551
+ 2024.3.27
552
+ - Changed MEMEMBED to push TER to output file
553
+ 2024.3.18:
554
+ - Separation of function in classes
555
+ - Better management of ppm3 alignment function
556
+ 2024.2.9:
557
+ - Fixed help typo
558
+ - PACKMOL Update to fix FORCED output
559
+ 2023.8.8:
560
+ - Added siWT4 COM to avoid overlaps
561
+ - Fixed deprecated np.float calls
562
+ - Added ppm3 support and code
563
+ - Shift water box if --dims is used to add at least 5A water on membrane surface
564
+ - Add packmol finetuning parameters
565
+ 2023.2.24:
566
+ - Changed versioning to CalVer
567
+ - Updated packmol
568
+ - Added all amber supported ions and OPC3
569
+ - Added option to generate HMR systems
570
+ - Added control for minimization function and pmemd.cuda
571
+ - Added option to use pdb2pqr to protonate, if available
572
+ - Multiple small changes and cleanup
573
+ v1.2.3:
574
+ - Added support for Lipid21 sphingolipids
575
+ - Add channel_plug flag and fix 2LPG head atoms in memgen.parm
576
+ - Add function to identify sterol lipid piercing within packed box
577
+ - Limit packing of sterols in the rim under some conditions
578
+ v1.2.1:
579
+ - Fixed using %v/v concentrations for solutes.
580
+ v1.2.0:
581
+ - Added sterols ergosterol, stigmasterol, sitosterol, campesterol
582
+ - Reformated and cleaned FF parameter files
583
+ - Fixed bogus packing params
584
+ - Added functionality for using alternate solvents
585
+ - User provided memgen.parm or solvent.parm extend and not only replace parameters used by default
586
+ - Added support for coarse graining systems with SIRAH
587
+ - Fixed bug that caused charmmlipid2amber to fail when packing a single residue molecule
588
+ - Support for Lipid21 / Lipid17 can be selected.
589
+ v1.1.0:
590
+ - Added parameters for cardiolipin headgroup
591
+ - New PDBs generated with stereocenter constraints
592
+ - Added --solute_prot_dist to set free diffusion simulations with ligands starting at a distance of a potential target.
593
+ - Fixed rounding error for solute placement in water compartments
594
+ - Added flags --apl_offset --self_assembly
595
+ - Small code changes
596
+ v1.0.8:
597
+ - Added preliminary code for --double_span option for proteins with two transmembrane regions. Can be used with --preoriented given proper MEM atoms
598
+ - Added preliminary code for using different surface geometries
599
+ - Added --tight_box to use dimensions calculated during the packing process in the leap parametrization
600
+ v1.0.7:
601
+ - Added APL values derived from Lipid17 DOPC:X 4:1 300K 1 bar. Flag to use old APL values added.
602
+ - Allow to pass custom memgen.parm file with --memgen_parm
603
+ v1.0.5:
604
+ - Changed pdb file distro
605
+ - Added experimental pdbs for all possible combinations
606
+ - Added PI & multiple protonation states parameters
607
+ - memgen.parm to all missing lipids
608
+ v1.0.2:
609
+ - Fixed the way dims and solute_inmem are handled
610
+ - Included parameters for lysophospholipid heads PE PG PC // BETA! (pdbs and memgen.parm)
611
+ - Fixed and updated internal charmmlipid2amber.csv
612
+ - Added missing MG pdb
613
+ v1.0.1:
614
+ - Added flags dims, gaff2 and solute_charge
615
+ - Possible to specify concentrations as percentages. Depends on pdbremix at the moment!
616
+ v1.0.0:
617
+ - Modified POPC pdb to avoid bug that apparently caused it to be stuck in a maxima
618
+ - Fixed bug while trying to find lipid APL with the same headgroup
619
+ - Newest packmol version 18.169
620
+ - Inclusion of boost 1.69 // compatible with gcc 8 compilers // AmberTools19 includes boost!
621
+ - Mac compatible compilation code
622
+ v0.9.95:
623
+ - Added writeout flag to control intermediate saves. Allows shorter nloops.
624
+ - Adapted code to Leandro's nloop_all.
625
+ - New packmol version with bug fixes (18.104). Should fix isues with Windows WSL.
626
+ - Python 3 friendly code.
627
+ - Added cubic flag for solvating. reducebuild for protonating HIS.
628
+ - Fixed multi bilayer z-dim size bug.
629
+ - Changed solute_con to accept either number of molecules or concentrations.
630
+ v0.9.9:
631
+ - Possibility to build stacked membrane systems by calling --lipids multiple times. PDB files to be embeded have to be included with --pdb now, to make possible to specify multiple inputs.
632
+ - A charge imbalance can be specified between compartments (CompEL!)
633
+ - If desired, a specific per leaflet composition can be specified.
634
+ - The orientation by MEMEMBED is with the N-terminus to the "inside" (or to lower z values). Added flag (--n_ter) to set this per protein in case of multiple bilayers.
635
+ v0.9.8:
636
+ - Modified print commands for logging statements.
637
+ - Added optional grid building command (testing!)
638
+ - Added functions that allow minimization and parametrization, given that AMBERHOME is defined
639
+ - Added option to keep ligands after protein alignment
640
+ v0.9.7:
641
+ - Check if ions are required before adding the line to packmol (avoids "bug" that adds one molecule even when the number is 0)
642
+ v0.9.6:
643
+ - Possible to add solutes in water based on PDB input
644
+ - Modified sigterm command for runs
645
+ - Reduced the verbosity. Can be called with --verbose
646
+ v0.9.5:
647
+ - Changed parsing system to argparse
648
+ - Adapted to work with Wooey
649
+ - Implemented charmmlipid2amber as a module // charmm and amber outputs
650
+ v0.9.1:
651
+ - Now is possible to create membranes without proteins by setting the PDB as None
652
+ - The xy dimensions can be set with the flag -distxy_fix. This flag is required if no PDB is given
653
+ v0.9:
654
+ - Multiple lipids available! (-available_lipids for a list)
655
+ - Detection of neutralization / salt concentration included
656
+ v0.7:
657
+ - Volume estimation by building grid based on PDBREMIX
658
+ - Search for AMBERHOME definition, using reduce if available
659
+ - Automated alignment available based on MEMEMBED
660
+ - Tiny code clean-up
661
+ v0.3:
662
+ - Distance is measured considering worst case scenario (max x and y considered to be on the diagonal)
663
+ - Added progress bar for all-together packing step
664
+ - Filter for non-defined arguments