PyFraME 0.4.0__tar.gz → 0.5.0__tar.gz
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.
- pyframe-0.5.0/CHANGELOG.md +212 -0
- pyframe-0.5.0/CITATION +6 -0
- pyframe-0.5.0/CITATION.cff +44 -0
- pyframe-0.5.0/CONTRIBUTORS +10 -0
- pyframe-0.5.0/LICENSE +373 -0
- pyframe-0.5.0/MANIFEST.in +12 -0
- pyframe-0.5.0/PKG-INFO +1137 -0
- pyframe-0.5.0/PyFraME.egg-info/PKG-INFO +1137 -0
- pyframe-0.5.0/PyFraME.egg-info/SOURCES.txt +156 -0
- pyframe-0.5.0/PyFraME.egg-info/requires.txt +12 -0
- pyframe-0.5.0/README.md +1092 -0
- pyframe-0.5.0/pyframe/__init__.py +494 -0
- pyframe-0.5.0/pyframe/common/__init__.py +12 -0
- pyframe-0.5.0/pyframe/common/arrays.py +58 -0
- pyframe-0.5.0/pyframe/common/constants.py +37 -0
- pyframe-0.5.0/pyframe/common/elements.py +77 -0
- pyframe-0.5.0/pyframe/common/lennard_jones.py +116 -0
- pyframe-0.5.0/pyframe/common/log.py +221 -0
- pyframe-0.5.0/pyframe/common/potential_document.py +217 -0
- pyframe-0.5.0/pyframe/common/simulation_box.py +103 -0
- pyframe-0.5.0/pyframe/common/tensor_components.py +285 -0
- pyframe-0.5.0/pyframe/common/tests/constants_test.py +44 -0
- pyframe-0.5.0/pyframe/common/tests/elements_test.py +48 -0
- pyframe-0.5.0/pyframe/common/tests/lennard_jones_test.py +52 -0
- pyframe-0.5.0/pyframe/common/tests/log_test.py +250 -0
- pyframe-0.5.0/pyframe/common/tests/simulation_box_test.py +166 -0
- pyframe-0.5.0/pyframe/common/tests/tensor_components_test.py +134 -0
- pyframe-0.5.0/pyframe/common/units.py +229 -0
- pyframe-0.5.0/pyframe/construction/__init__.py +14 -0
- pyframe-0.5.0/pyframe/construction/atoms.py +399 -0
- pyframe-0.5.0/pyframe/construction/data/alep.csv +385 -0
- pyframe-0.5.0/pyframe/construction/data/cp3.csv +9518 -0
- pyframe-0.5.0/pyframe/construction/data/ff03.csv +3390 -0
- pyframe-0.5.0/pyframe/construction/data/ff94.csv +3389 -0
- pyframe-0.5.0/pyframe/construction/data/lipid14.csv +565 -0
- pyframe-0.5.0/pyframe/construction/data/lipid17.csv +549 -0
- pyframe-0.5.0/pyframe/construction/data/sep.csv +139 -0
- pyframe-0.5.0/pyframe/construction/data/tip3p.csv +34 -0
- pyframe-0.5.0/pyframe/construction/exact_coordinates.py +911 -0
- pyframe-0.5.0/pyframe/construction/fragments.py +905 -0
- pyframe-0.5.0/pyframe/construction/from_system.py +166 -0
- pyframe-0.5.0/pyframe/construction/potential_builder.py +1714 -0
- pyframe-0.5.0/pyframe/construction/potentials.py +419 -0
- pyframe-0.5.0/pyframe/construction/project.py +31 -0
- pyframe-0.5.0/pyframe/construction/readers.py +1123 -0
- pyframe-0.5.0/pyframe/construction/regions.py +1348 -0
- pyframe-0.5.0/pyframe/construction/system.py +64 -0
- pyframe-0.5.0/pyframe/construction/task_farming.py +551 -0
- pyframe-0.5.0/pyframe/construction/tests/atoms_test.py +529 -0
- pyframe-0.5.0/pyframe/construction/tests/conftest.py +85 -0
- pyframe-0.5.0/pyframe/construction/tests/data/README.md +55 -0
- pyframe-0.5.0/pyframe/construction/tests/data/precision_water.gro +45 -0
- pyframe-0.5.0/pyframe/construction/tests/data/precision_water.trr +0 -0
- pyframe-0.5.0/pyframe/construction/tests/data/precision_water.xtc +0 -0
- pyframe-0.5.0/pyframe/construction/tests/data/precision_water_double.trr +0 -0
- pyframe-0.5.0/pyframe/construction/tests/data/trajectory.gro +11 -0
- pyframe-0.5.0/pyframe/construction/tests/data/trajectory.mdp +2 -0
- pyframe-0.5.0/pyframe/construction/tests/data/trajectory.top +53 -0
- pyframe-0.5.0/pyframe/construction/tests/data/trajectory.tpr +0 -0
- pyframe-0.5.0/pyframe/construction/tests/data/trajectory.xtc +0 -0
- pyframe-0.5.0/pyframe/construction/tests/exact_coordinates_test.py +727 -0
- pyframe-0.5.0/pyframe/construction/tests/fragments_test.py +637 -0
- pyframe-0.5.0/pyframe/construction/tests/from_system_test.py +178 -0
- PyFraME-0.4.0/pyframe/tests/test_standard_potentials.py → pyframe-0.5.0/pyframe/construction/tests/parameter_sets_test.py +16 -9
- pyframe-0.5.0/pyframe/construction/tests/potential_builder_test.py +2174 -0
- pyframe-0.5.0/pyframe/construction/tests/potentials_test.py +268 -0
- pyframe-0.5.0/pyframe/construction/tests/readers_test.py +1040 -0
- pyframe-0.5.0/pyframe/construction/tests/regions_test.py +1033 -0
- pyframe-0.5.0/pyframe/construction/tests/system_test.py +106 -0
- pyframe-0.5.0/pyframe/construction/tests/task_farming_test.py +989 -0
- pyframe-0.5.0/pyframe/construction/tests/trajectory_test.py +2565 -0
- pyframe-0.5.0/pyframe/construction/tests/utilities_test.py +60 -0
- pyframe-0.5.0/pyframe/construction/tests/writers_test.py +1413 -0
- pyframe-0.5.0/pyframe/construction/trajectory.py +1696 -0
- pyframe-0.5.0/pyframe/construction/utilities.py +96 -0
- pyframe-0.5.0/pyframe/construction/writers.py +1587 -0
- pyframe-0.5.0/pyframe/embedding/__init__.py +19 -0
- pyframe-0.5.0/pyframe/embedding/combination_rules.py +63 -0
- pyframe-0.5.0/pyframe/embedding/dispersion_interactions.py +191 -0
- pyframe-0.5.0/pyframe/embedding/electrostatic_interactions.py +494 -0
- pyframe-0.5.0/pyframe/embedding/engine/computation.cpp +882 -0
- pyframe-0.5.0/pyframe/embedding/engine/computation.h +142 -0
- pyframe-0.5.0/pyframe/embedding/engine/engine.cpp +1480 -0
- pyframe-0.5.0/pyframe/embedding/engine/global.cpp +42 -0
- pyframe-0.5.0/pyframe/embedding/engine/global.h +62 -0
- pyframe-0.5.0/pyframe/embedding/engine.pyi +94 -0
- pyframe-0.5.0/pyframe/embedding/fragment.py +176 -0
- pyframe-0.5.0/pyframe/embedding/induction_interactions.py +763 -0
- pyframe-0.5.0/pyframe/embedding/integral_driver_template.py +482 -0
- pyframe-0.5.0/pyframe/embedding/interaction_tensor.py +58 -0
- pyframe-0.5.0/pyframe/embedding/model.py +784 -0
- pyframe-0.5.0/pyframe/embedding/options.py +166 -0
- pyframe-0.5.0/pyframe/embedding/particle.py +653 -0
- pyframe-0.5.0/pyframe/embedding/polytensor.py +321 -0
- pyframe-0.5.0/pyframe/embedding/read_input.py +729 -0
- pyframe-0.5.0/pyframe/embedding/repulsion_interactions.py +191 -0
- pyframe-0.5.0/pyframe/embedding/solvers.py +1272 -0
- pyframe-0.5.0/pyframe/embedding/subsystem.py +1441 -0
- pyframe-0.5.0/pyframe/embedding/tensor_tools.py +392 -0
- pyframe-0.5.0/pyframe/embedding/tests/conftest.py +5421 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/HF.json +102 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/Ne_test.json +59 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/acrolein_wat_test.json +282 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/act_wat_2.json +2300 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/act_wat_big.json +78310 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/act_wat_mid.json +2134 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/act_wat_small.json +694 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/act_wat_test.json +328 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/butadiene_water.json +635 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/missing_classical_fragments_two_atoms_test.json +31 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/missing_nuclei_two_atoms_test.json +71 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/no_subsystems.json +1 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/two_atom_test.json +92 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/two_oxygen_nine_six_test.json +116 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/two_oxygen_split_lj_test.json +81 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/two_oxygen_test.json +81 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/two_wat_test.json +232 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/wat_in_wat_missing_lj_test.json +482 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/wat_in_wat_split_lj_test.json +724 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/wat_in_wat_test.json +486 -0
- pyframe-0.5.0/pyframe/embedding/tests/data/wat_in_wat_zero_lj_test.json +724 -0
- pyframe-0.5.0/pyframe/embedding/tests/dispersion_interactions_test.py +119 -0
- pyframe-0.5.0/pyframe/embedding/tests/electrostatic_interactions_test.py +371 -0
- pyframe-0.5.0/pyframe/embedding/tests/engine_arguments_test.py +589 -0
- pyframe-0.5.0/pyframe/embedding/tests/engine_stub_test.py +53 -0
- pyframe-0.5.0/pyframe/embedding/tests/engine_test.py +51 -0
- pyframe-0.5.0/pyframe/embedding/tests/fragment_test.py +156 -0
- pyframe-0.5.0/pyframe/embedding/tests/induction_interactions_test.py +1054 -0
- pyframe-0.5.0/pyframe/embedding/tests/induction_mpi_worker.py +469 -0
- pyframe-0.5.0/pyframe/embedding/tests/induction_parallel_test.py +205 -0
- pyframe-0.5.0/pyframe/embedding/tests/integral_driver_template_test.py +249 -0
- pyframe-0.5.0/pyframe/embedding/tests/interaction_tensor_test.py +1065 -0
- pyframe-0.5.0/pyframe/embedding/tests/lj_characterization_test.py +834 -0
- pyframe-0.5.0/pyframe/embedding/tests/lj_mpi_worker.py +69 -0
- pyframe-0.5.0/pyframe/embedding/tests/lj_parallel_test.py +109 -0
- pyframe-0.5.0/pyframe/embedding/tests/minimum_image_test.py +218 -0
- pyframe-0.5.0/pyframe/embedding/tests/model_test.py +741 -0
- pyframe-0.5.0/pyframe/embedding/tests/options_test.py +151 -0
- pyframe-0.5.0/pyframe/embedding/tests/particle_test.py +519 -0
- pyframe-0.5.0/pyframe/embedding/tests/performance.py +97 -0
- pyframe-0.5.0/pyframe/embedding/tests/polytensor_test.py +558 -0
- pyframe-0.5.0/pyframe/embedding/tests/read_input_test.py +887 -0
- pyframe-0.5.0/pyframe/embedding/tests/repulsion_interactions_test.py +120 -0
- pyframe-0.5.0/pyframe/embedding/tests/serial_test.py +52 -0
- pyframe-0.5.0/pyframe/embedding/tests/solvers_test.py +1019 -0
- pyframe-0.5.0/pyframe/embedding/tests/subsystem_test.py +1417 -0
- pyframe-0.5.0/pyframe/embedding/tests/tensor_tools_test.py +456 -0
- pyframe-0.5.0/pyframe/embedding/tests/totals_test.py +290 -0
- pyframe-0.5.0/pyframe/embedding/totals.py +259 -0
- pyframe-0.5.0/pyframe/py.typed +0 -0
- pyframe-0.5.0/pyframe/tests/api_test.py +97 -0
- pyframe-0.5.0/pyframe/tests/layering_test.py +138 -0
- pyframe-0.5.0/pyframe/version.py +8 -0
- pyframe-0.5.0/pyproject.toml +278 -0
- pyframe-0.5.0/setup.cfg +4 -0
- pyframe-0.5.0/setup.py +219 -0
- PyFraME-0.4.0/LICENSE +0 -674
- PyFraME-0.4.0/PKG-INFO +0 -326
- PyFraME-0.4.0/PyFraME.egg-info/PKG-INFO +0 -326
- PyFraME-0.4.0/PyFraME.egg-info/SOURCES.txt +0 -24
- PyFraME-0.4.0/PyFraME.egg-info/requires.txt +0 -5
- PyFraME-0.4.0/README.md +0 -297
- PyFraME-0.4.0/pyframe/__init__.py +0 -724
- PyFraME-0.4.0/pyframe/atoms.py +0 -134
- PyFraME-0.4.0/pyframe/fragments.py +0 -501
- PyFraME-0.4.0/pyframe/potentials.py +0 -299
- PyFraME-0.4.0/pyframe/process.py +0 -198
- PyFraME-0.4.0/pyframe/project.py +0 -767
- PyFraME-0.4.0/pyframe/readers.py +0 -491
- PyFraME-0.4.0/pyframe/regions.py +0 -367
- PyFraME-0.4.0/pyframe/system.py +0 -545
- PyFraME-0.4.0/pyframe/tests/test_atoms.py +0 -193
- PyFraME-0.4.0/pyframe/tests/test_utils.py +0 -61
- PyFraME-0.4.0/pyframe/utils.py +0 -183
- PyFraME-0.4.0/pyframe/writers.py +0 -734
- PyFraME-0.4.0/pyproject.toml +0 -6
- PyFraME-0.4.0/setup.cfg +0 -47
- PyFraME-0.4.0/setup.py +0 -3
- {PyFraME-0.4.0 → pyframe-0.5.0}/PyFraME.egg-info/dependency_links.txt +0 -0
- {PyFraME-0.4.0 → pyframe-0.5.0}/PyFraME.egg-info/top_level.txt +0 -0
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
|
4
|
+
and this project adheres to [Semantic Versioning](http://semver.org/).
|
|
5
|
+
|
|
6
|
+
<!-- How to write an entry: see the "Changelog" section of CONTRIBUTING.md. -->
|
|
7
|
+
|
|
8
|
+
## [0.5.0] 2026-10-13
|
|
9
|
+
### Added
|
|
10
|
+
- Embedding calculations. The new embedding module computes the interaction of a quantum region with its environment
|
|
11
|
+
through electrostatics, polarization, repulsion, and dispersion, with its contributions to the Fock matrix and to the
|
|
12
|
+
gradients and Hessians of the energy. The computationally intensive parts run in a compiled C++ engine. Contributed by
|
|
13
|
+
Jonas Vester with support from Georg Berger.
|
|
14
|
+
- A quantum chemistry program hands PyFraME its integrals through an integral driver: any class with the three methods
|
|
15
|
+
of `pyframe.IntegralDriver`, or a subclass of `pyframe.IntegralDriverTemplate`. Type checkers such as mypy check a
|
|
16
|
+
driver against `IntegralDriver`, so a missing or mistyped method shows before the program is run.
|
|
17
|
+
- Induced dipole solvers (JI-DIIS, DC-JI, and DC-JI-DIIS). Contributed by Toke Nørremølle Heegaard.
|
|
18
|
+
- Lennard-Jones repulsion and dispersion, with separate parameters for each and a choice of combination rules.
|
|
19
|
+
- Potentials from molecular dynamics: `Trajectory` reads a trajectory using MDAnalysis and builds a potential for every
|
|
20
|
+
frame, with the regions given as MDAnalysis atom selections. A region can be narrowed down to the fragments within a
|
|
21
|
+
distance of a reference, e.g. the water around a solute, measured across the periodic boundary if asked for.
|
|
22
|
+
Fragments can be split into named parts, e.g. a lipid into its head group and tails, with `split_fragments`.
|
|
23
|
+
- A JSON potential format that holds everything an embedding calculation needs. A molecular system can also be passed
|
|
24
|
+
to an embedding calculation directly, without a file.
|
|
25
|
+
- The quantum region includes its link or capping atoms, whose basis set can be chosen separately from the other atoms.
|
|
26
|
+
- Control over where PyFraME's messages go, to the console, to log files, or to memory (`pyframe.configure_logging`).
|
|
27
|
+
- More control over how jobs are run: the MPI command, the host, and commands to run before each job can be set, and
|
|
28
|
+
connections can be verified before a run.
|
|
29
|
+
- A dry run, `create_embedding_potential(only_create_inputs=True)`, which writes the input files and run scripts
|
|
30
|
+
without running anything.
|
|
31
|
+
- Files written by PyFraME record the version that wrote them.
|
|
32
|
+
- Ready-built packages for Linux (x86_64 and aarch64) and macOS (Apple silicon) for Python 3.11 to 3.14, so no compiler
|
|
33
|
+
is needed to install PyFraME there.
|
|
34
|
+
- PyFraME is marked as typed, so type checkers such as mypy and pyright check scripts against the types of its
|
|
35
|
+
functions and classes.
|
|
36
|
+
- Host programs and scripts can list the parameter sets shipped with PyFraME and describe each, with the fragments it
|
|
37
|
+
covers and its parameters (`pyframe.available_parameter_sets` and `pyframe.describe_parameter_set`).
|
|
38
|
+
- Lipids of `alep` (DMPC, POPC, and POPS) can be selected whole, e.g. `'resname POPC'`, in a region shared with other
|
|
39
|
+
molecules: the parameter set splits them and sets their exclusions, so they need neither splitting by hand nor MFCC
|
|
40
|
+
settings of their own. A lipid split by hand is corrected to the charge of the whole lipid.
|
|
41
|
+
- A parameter set of one's own can state the exclusions of its fragments and assemble fragments from parts, with
|
|
42
|
+
`# exclusion:` and `# parts:` lines above its header.
|
|
43
|
+
- The citation names all the authors of PyFraME, and is also given in `CITATION.cff`, which reference managers and
|
|
44
|
+
other tools read citation metadata from.
|
|
45
|
+
|
|
46
|
+
### Changed
|
|
47
|
+
- PyFraME is licensed under the Mozilla Public License 2.0 instead of the GPLv3+.
|
|
48
|
+
- Python 3.11 or newer is required. MDAnalysis, mpi4py, scikit-learn, QCElemental, and Fabric are new requirements,
|
|
49
|
+
and Dalton support is optional (`pip install pyframe[dalton]`). An MPI library is needed only for parallel embedding
|
|
50
|
+
calculations, and building from source needs a C++ compiler with OpenMP and the Eigen library.
|
|
51
|
+
- Parameter set files name the component and unit of each column, e.g. `M_000[e]` or `epsilon[kJ/mol]`. Files in the
|
|
52
|
+
old format are rejected; the bundled ones have been converted.
|
|
53
|
+
- Several names have changed, and scripts that use them need updating:
|
|
54
|
+
- Standard potentials are now called parameter sets: `use_standard_potentials`, `standard_potential_model`, and
|
|
55
|
+
`standard_potential_exclusion_type` are now `use_parameter_set`, `parameter_set`, and
|
|
56
|
+
`parameter_set_exclusion_type`. An old name is refused with an error that gives the new one.
|
|
57
|
+
- `Project` is now `CreatePotential`.
|
|
58
|
+
- `Potential` and `PotentialDict` are now `pyframe.Site` and `pyframe.SiteList`. Sites are numbered from zero
|
|
59
|
+
(potential files still count from one), their multipoles and polarizabilities are arrays instead of `M0`, `P11`,
|
|
60
|
+
and similar attributes, and `repulsion` and `dispersion` replace `sigma` and `epsilon`.
|
|
61
|
+
- Atoms and fragments can no longer be changed in place. `copy_with` makes a changed copy, and
|
|
62
|
+
`add_hydrogen_links` and `add_cap_links` are now `with_hydrogen_links` and `with_cap_atoms`, which return a new
|
|
63
|
+
fragment.
|
|
64
|
+
- `FragmentDict` is removed. Fragments are held in read-only mappings keyed by the index of their residue, as
|
|
65
|
+
`Fragment.index` gives it, rather than by a name such as `10_A_ILE`.
|
|
66
|
+
- Bonds between fragments are in the `topology` of a snapshot instead of `Fragment.bonded_fragments`, and MFCC belongs
|
|
67
|
+
to the region instead of the fragment: `Region.create_mfcc_fragments`, `Region.capped_fragments`, and
|
|
68
|
+
`Region.concaps` replace their `Fragment` counterparts. `Fragment.region` is removed, since a fragment can be in
|
|
69
|
+
more than one region, and a cap can span several fragments.
|
|
70
|
+
- `number_of_atoms` is now `num_atoms`, `analyse_bonding` is now `analyze_bonding`, and `omp_threads` is now
|
|
71
|
+
`omp_num_threads`.
|
|
72
|
+
- The default parameter set is `pyframe-2026` instead of `sep`: the amino acids of `cp3`, the water, solvents, and ions
|
|
73
|
+
of `sep`, and the lipids of `alep`, so a protein in a membrane with its solvent and ions can be a single region.
|
|
74
|
+
- In `sep`, phenol is `PHN` instead of `PHE`, which is phenylalanine; rename the residue where phenol is called `PHE`.
|
|
75
|
+
- Environment sites where the core region cuts a bond are adjusted: a site replaced by a capping atom is removed, and
|
|
76
|
+
sites close to a link atom move their charge and polarizability to the rest of their region.
|
|
77
|
+
- Fragment charges are rounded to the nearest integer.
|
|
78
|
+
- Running the fragment calculations is more robust: results come back in order, a run whose workers have died stops
|
|
79
|
+
with an error instead of hanging, paths with spaces work, and a job stops at its first failing command. The
|
|
80
|
+
communication port is chosen automatically, and a scratch directory is looked for under `$SCRATCH` and `/scratch`
|
|
81
|
+
first.
|
|
82
|
+
- PyFraME reports through Python's logging instead of printing, and importing it prints nothing.
|
|
83
|
+
- The fragment calculations are named after the index of the residue of their fragment, e.g.
|
|
84
|
+
`fragment-9_dalton_multipoles.out`, and a file `fragments.txt` beside them says which fragment each is of, so the
|
|
85
|
+
calculations of a work directory of 0.4 are run again. Messages about a fragment say where to find it, e.g.
|
|
86
|
+
`ILE 10, chain A, resindex 9, atoms index 120:138`.
|
|
87
|
+
|
|
88
|
+
### Removed
|
|
89
|
+
- `MolecularSystem`: a structure is read as a `Trajectory` of one frame, and regions are given as MDAnalysis atom
|
|
90
|
+
selections. [Moving from MolecularSystem](README.md#moving-from-molecularsystem) lists what replaces each call.
|
|
91
|
+
|
|
92
|
+
### Fixed
|
|
93
|
+
- PDB and PQR files with more than 9999 residues, where residue numbers repeat, are read correctly.
|
|
94
|
+
- The elements of HSD and HSE residues are recognized.
|
|
95
|
+
- SSH jobs no longer fail on hosts that are not yet known; their host keys are accepted automatically.
|
|
96
|
+
- MFCC could leave some lone atoms out; proteins at the default MFCC order of 2 were not affected.
|
|
97
|
+
- PDE calculations could take the fragment densities from the wrong calculation.
|
|
98
|
+
- Writing the core region removed the atoms replaced by caps from the environment.
|
|
99
|
+
- Writing a potential file changed the sites' exclusion lists.
|
|
100
|
+
- A core region without fragments gave an unclear error.
|
|
101
|
+
- A potential built from parameter sets alone no longer leaves an empty directory for every snapshot, and the core can
|
|
102
|
+
be written before the potential, since `write_core` and `write_potential` make the directory they write into.
|
|
103
|
+
|
|
104
|
+
## [0.4.0] 2021-06-07
|
|
105
|
+
### Added
|
|
106
|
+
- Added a `get_remaining_fragments` method to the `MolecularSystem` class that will return all remaining fragments.
|
|
107
|
+
- Added AMBER Lipid14 and Lipid17 charges.
|
|
108
|
+
|
|
109
|
+
### Changed
|
|
110
|
+
- Reduced cost of PDE calculations by combining the SCFs used to calculate polarizability and fragment densities.
|
|
111
|
+
- Region options, '*x*\_program', '*x*\_method', '*x*\_xcfun', and '*x*\_basis', where *x* can be multipoles,
|
|
112
|
+
polarizabilites, etc., have been unified to single options 'program', 'method', 'xcfun', and 'basis', that
|
|
113
|
+
apply to all properties associated with a given region. All unused '*x*\_model' properties have been removed.
|
|
114
|
+
- Regular expressions can now be used for selecting atoms for new fragment definitions when splitting fragments.
|
|
115
|
+
- Minimum requirement changed to Python 3.7 (though Python 3.6 should still work but is not guaranteed
|
|
116
|
+
starting from this release).
|
|
117
|
+
- Redistribute surplus charge of non-MFCC standard potential fragments if total fragment charge is not integer.
|
|
118
|
+
|
|
119
|
+
### Fixed
|
|
120
|
+
- Process jobs without ssh when using only a single local machine. This fixes problems with job processing
|
|
121
|
+
that were present on some linux configurations.
|
|
122
|
+
- Reset of the molecular system.
|
|
123
|
+
- IndexError exception that would occur when a charge is missing (i.e. because it is zero).
|
|
124
|
+
- Adjusted averaged lipid embedding parameters to make the total charge integer (was off by -4e-5).
|
|
125
|
+
- Raise Exception when trying to read empty or non-existent Dalton LoProp output file.
|
|
126
|
+
|
|
127
|
+
## [0.3.0] 2020-05-11
|
|
128
|
+
### Added
|
|
129
|
+
- Polarizable density embedding (PDE) model.
|
|
130
|
+
- see https://doi.org/10.1021/jp510138k and https://doi.org/10.1021/acs.jpclett.7b02788 for details.
|
|
131
|
+
- Print license (`pyframe.print_license()`).
|
|
132
|
+
- Added [contributing guidelines](https://gitlab.com/pyframe-project/pyframe/-/blob/master/CONTRIBUTING.md).
|
|
133
|
+
- Cost-effective polarizable protein potential (CP3).
|
|
134
|
+
- see https://doi.org/10.1021/acs.jctc.9b00616 for details
|
|
135
|
+
- The PDB input file reader will now try to guess the element based on the atom name, when the element field is missing.
|
|
136
|
+
|
|
137
|
+
### Fixed
|
|
138
|
+
- Settings, i.e. method, basis set, etc., when computing polarizabilities
|
|
139
|
+
separately from multipoles using Dalton LoProp have been fixed.
|
|
140
|
+
- Fixed bug that in some cases resulted in corrupt core regions when it consisted of two
|
|
141
|
+
fragments or more.
|
|
142
|
+
|
|
143
|
+
### Changed
|
|
144
|
+
- Minimum requirement changed to Python 3.6.
|
|
145
|
+
- Allow extracting fragments with a single item, e.g. system.get\_fragments\_by\_chain\_id('P'),
|
|
146
|
+
where it was required to always use lists before.
|
|
147
|
+
- Remove use of Numba and instead use SciPy and NumPy only.
|
|
148
|
+
|
|
149
|
+
## [0.2.0] - 2018-10-03
|
|
150
|
+
### Added
|
|
151
|
+
- Moved the suggested BibTeX snippet into the [CITATION
|
|
152
|
+
file](https://gitlab.com/pyframe-project/pyframe/-/blob/master/CITATION).
|
|
153
|
+
- Added sodium and chloride charge and isotropic polarizability to
|
|
154
|
+
solvent embedding potential.
|
|
155
|
+
- Added calcium, magnesium, potassium, zinc, and bromine charge and
|
|
156
|
+
isotropic polarizability to solvent embedding potential.
|
|
157
|
+
- New option to choose exclusion type for standard potentials.
|
|
158
|
+
Currently it can be either 'fragment', which excludes all
|
|
159
|
+
interactions within a fragment, or 'mfcc', which is the MFCC type
|
|
160
|
+
exclusions.
|
|
161
|
+
- Added AMBER ff94 and ff03 standard potentials.
|
|
162
|
+
- Improve element recognition.
|
|
163
|
+
- Surplus charge of a region treated using MFCC is now redistributed
|
|
164
|
+
among all sites in the affected region, ensuring that the sum of
|
|
165
|
+
partial charges is equal to the formal charge of the region.
|
|
166
|
+
- Added averaged lipid embedding parameters from S. Witzke et al.
|
|
167
|
+
J. Comput. Chem. 38 (2017) 601-611.
|
|
168
|
+
|
|
169
|
+
### Fixed
|
|
170
|
+
- Fixed wrong asserts which would have caused errors if octopoles or
|
|
171
|
+
higher were requested.
|
|
172
|
+
- All polarizabilities up to octopole-octopole are now present.
|
|
173
|
+
- Errors when using CAM-B3LYP in serial Dalton calculations (which now
|
|
174
|
+
always use `.DIRECT`).
|
|
175
|
+
- Error when LD\_LIBRARY\_PATH environment variable was not set.
|
|
176
|
+
- Fixed erroneous exclusion lists when different parts of a molecule,
|
|
177
|
+
e.g. protein, are placed in different regions.
|
|
178
|
+
- Radius of Li, Na, Mg, K, and Ca (used in bond detection) adjusted to
|
|
179
|
+
the effective ionic radius by R. D. Shannon, Acta. Cryst. A32 (1976), 751.
|
|
180
|
+
- Naming bug when adding hydrogen-link atoms where the donor-atom name
|
|
181
|
+
would erroneously have _link_ appended to it.
|
|
182
|
+
|
|
183
|
+
### Changed
|
|
184
|
+
- Running the test suite now requires pytest (unittests can be run by typing `pytest --pyargs pyframe`).
|
|
185
|
+
- The default bond detection threshold factor has been set to 1.15 instead of 1.2.
|
|
186
|
+
- Improved error message when there is a mismatch between the number of sites in
|
|
187
|
+
an output file compared to the number of sites in the fragment read in from input.
|
|
188
|
+
- Default is now to first try to find a free communication port.
|
|
189
|
+
|
|
190
|
+
## [0.1.1] - 2018-02-08
|
|
191
|
+
### Changed
|
|
192
|
+
- There is now a check for empty output files from fragment
|
|
193
|
+
calculations to prevent deletion of subdirectories of failed
|
|
194
|
+
fragment calculations.
|
|
195
|
+
- Now hydrogen caps between core region and other regions are always
|
|
196
|
+
used.
|
|
197
|
+
- Efficiency-related changes:
|
|
198
|
+
- compute angles, distances, distance matrices using Numba jit
|
|
199
|
+
decorator (introduces Numba dependency and removes SciPy dependency).
|
|
200
|
+
- removed some unnecessary property decorators.
|
|
201
|
+
- Refactored the atoms module (faster and safer).
|
|
202
|
+
|
|
203
|
+
### Fixed
|
|
204
|
+
- Bug in MOLCAS LoProp ('Fragment' object has no attribute 'xyz').
|
|
205
|
+
- Using Dalton LoProp with multipole orders lower than two no longer
|
|
206
|
+
fails.
|
|
207
|
+
- Bug in charge redistribution where negative surplus charge would not
|
|
208
|
+
be redistributed.
|
|
209
|
+
|
|
210
|
+
## [0.1.0] - 2017-02-20
|
|
211
|
+
### Added
|
|
212
|
+
- Initial version.
|
pyframe-0.5.0/CITATION
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
@misc{pyframe:0.5.0,
|
|
2
|
+
author = {Olsen, J. M. H. and Reinholdt, P. and Vester, J. and Heegaard, T. N. and Berger, G.},
|
|
3
|
+
title = {{PyFraME}: {P}ython framework for {F}ragment-based {M}ultiscale {E}mbedding (version 0.5.0)},
|
|
4
|
+
year = {2026},
|
|
5
|
+
doi = {10.5281/zenodo.22996201},
|
|
6
|
+
note = {See https://gitlab.com/pyframe-project/pyframe}}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: If you use PyFraME, please cite the version you used as below.
|
|
3
|
+
title: "PyFraME: Python framework for Fragment-based Multiscale Embedding"
|
|
4
|
+
type: software
|
|
5
|
+
version: 0.5.0
|
|
6
|
+
date-released: "2026-10-13"
|
|
7
|
+
doi: 10.5281/zenodo.22996201
|
|
8
|
+
identifiers:
|
|
9
|
+
- type: doi
|
|
10
|
+
value: 10.5281/zenodo.22996201
|
|
11
|
+
description: This version, 0.5.0.
|
|
12
|
+
- type: doi
|
|
13
|
+
value: 10.5281/zenodo.775113
|
|
14
|
+
description: All versions, resolving to the latest.
|
|
15
|
+
authors:
|
|
16
|
+
- given-names: Jógvan Magnus Haugaard
|
|
17
|
+
family-names: Olsen
|
|
18
|
+
orcid: https://orcid.org/0000-0001-7487-944X
|
|
19
|
+
- given-names: Peter
|
|
20
|
+
family-names: Reinholdt
|
|
21
|
+
orcid: https://orcid.org/0000-0003-2406-700X
|
|
22
|
+
- given-names: Jonas
|
|
23
|
+
family-names: Vester
|
|
24
|
+
orcid: https://orcid.org/0000-0001-8584-1295
|
|
25
|
+
- given-names: Toke Nørremølle
|
|
26
|
+
family-names: Heegaard
|
|
27
|
+
orcid: https://orcid.org/0009-0008-8334-1893
|
|
28
|
+
- given-names: Georg
|
|
29
|
+
family-names: Berger
|
|
30
|
+
orcid: https://orcid.org/0009-0007-8557-0975
|
|
31
|
+
abstract: >-
|
|
32
|
+
PyFraME builds embedding potentials for multiscale calculations from molecular
|
|
33
|
+
structures and molecular dynamics trajectories, fragment by fragment or from
|
|
34
|
+
parameter sets, and computes the interaction of a quantum region with its
|
|
35
|
+
environment for the quantum chemistry programs it is coupled to.
|
|
36
|
+
keywords:
|
|
37
|
+
- computational chemistry
|
|
38
|
+
- multiscale modeling
|
|
39
|
+
- QM/MM
|
|
40
|
+
- polarizable embedding
|
|
41
|
+
- fragment-based methods
|
|
42
|
+
license: MPL-2.0
|
|
43
|
+
repository-code: https://gitlab.com/pyframe-project/pyframe
|
|
44
|
+
url: https://gitlab.com/pyframe-project/pyframe
|
pyframe-0.5.0/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# What the sdist carries beyond what setuptools finds itself, i.e. the packages,
|
|
2
|
+
# their package data, and the sources and headers of the engine extension, which
|
|
3
|
+
# setup.py declares. The tests are not packages, so they are grafted here, for
|
|
4
|
+
# the sdist job, which runs them from the sdist. None of this reaches the wheel,
|
|
5
|
+
# which carries only the package data pyproject.toml names.
|
|
6
|
+
include CHANGELOG.md CITATION CITATION.cff CONTRIBUTORS
|
|
7
|
+
graft pyframe/tests
|
|
8
|
+
graft pyframe/common/tests
|
|
9
|
+
graft pyframe/construction/tests
|
|
10
|
+
graft pyframe/embedding/tests
|
|
11
|
+
# Bytecode that a test run has left in the grafted directories.
|
|
12
|
+
global-exclude *.py[cod]
|