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

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.

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.0.tar.gz (64.0 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.0-py3-none-any.whl (69.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novemberff-0.6.0.tar.gz
  • Upload date:
  • Size: 64.0 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.0.tar.gz
Algorithm Hash digest
SHA256 9c607580241b8f989ddf7937ed01febd036c43ced82539ac2eb15d819efe4ecf
MD5 a1148df2ef6afbe1d5d87a273f327662
BLAKE2b-256 b9adf5c9ad166c912ad3d937083080c2f6c13ae36ac01b08e277b5f05176b03e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: novemberff-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 69.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e69dda3cad7ee26c10e4d686e87a1b651327215e77480c778bb9496b2268cd4
MD5 ec8897ae1b1c70b64077d4b8c7e30af6
BLAKE2b-256 fb136bfd7f45be9183773e042b3f3ff2d6cd5e17328d70a256525276e43048c2

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