Skip to main content

Custom implementation of the AMBER forcefield, focused on simplicity and verbose outputs.

Project description

NOVEMBERFF

NovemberFF (implemeNtatiOn of VErbose aMBER ForceField) is a custom implementation of the AMBER forcefield, inspired by OpenMM's C++ source. NovemberFF's aim is not to be performant, but rather to be compact and easy to modify/customize. It also provides by default the option to obtain verbose outputs, i.e. the energies of every singular molecular interaction in arrays (instead of their sum).

  • Current outputs supported:

    • Bonded energies
    • Angle energies
    • Dihedral (Torsion) energies
    • LennardJones energies
    • Coulomb energies
  • Current forcefield formats supported:

    • XML
  • Current forcefields packed along NovemberFF (at novemberff/_data):

    • RNA.OL3.xml for RNA
    • amber99sb.xml for protein
    • amber99sb-ucb.xml for protein

Requirements

  • currently depends on MDAnalysis for parsing the PDB structures

Examples

  • display energy sums: python3 main.py rna testdata/1ato.pdb python3 main.py prot testdata/prot.pdb

  • save energy arrays: python3 main.py rna testdata/1ato.pdb testdata/output/1ato python3 main.py prot testdata/prot.pdb testdata/output/prot

TODO

  • improve CLI.
  • add documentation.
  • add more forcefields.
  • improve performance.
    • remove MDAnalysis dependency for PDB parsing.
    • improve bond_graphs's graph data structure.
  • improve the residue/atom labels fixing procedures.
  • finish refactoring of parser base class and forcefield.from_xml (i.e. should be Parser's responsability to yield the needed data, not Forcefield).
  • allow to specify the forcefield to use in main.py.
  • improve the option for saving the molecule's topology features (bonds, angles, etc), as well as their geometry values. Add it to the CLI. Add tests.
  • allow the XML parser to deal with files were new lines are missing.
  • improve Utils.solve_forcefield_path

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

novemberff-0.6.1.tar.gz (102.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

novemberff-0.6.1-py3-none-any.whl (109.8 kB view details)

Uploaded Python 3

File details

Details for the file novemberff-0.6.1.tar.gz.

File metadata

  • Download URL: novemberff-0.6.1.tar.gz
  • Upload date:
  • Size: 102.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for novemberff-0.6.1.tar.gz
Algorithm Hash digest
SHA256 3a88fce25b927e58e5f5101a8c67ea0ac1b6be0eb54ff1b2350745039de2beeb
MD5 4c291f5b09e7cfd2f0dde415cc4d212b
BLAKE2b-256 29785266c085399426bb0d2a714a80198057e7e3853944312703f8d6db664d48

See more details on using hashes here.

File details

Details for the file novemberff-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: novemberff-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 109.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for novemberff-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8199bd9962d4d41f220ea3b4a8d7271739b4c5f69256a2fec007a669c4dd55f7
MD5 b915d244bac73cf91de5efaee5a53fe4
BLAKE2b-256 046535f2a74d10cf82888c8194d464ae2ee7ed2641872f06eb25c44898423ee0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page