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.4.0.tar.gz (63.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.4.0-py3-none-any.whl (68.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novemberff-0.4.0.tar.gz
  • Upload date:
  • Size: 63.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.4.0.tar.gz
Algorithm Hash digest
SHA256 d982fd1337dea3ab31f3796ccbe2f70667809f08c24e0ad96278f08aec507680
MD5 8adb2ce6212e776cdf55dcc65f21c582
BLAKE2b-256 ba9139762ba723c43129bec8461d0715a3f39e0fef1065b2ea6e58f190b91930

See more details on using hashes here.

File details

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

File metadata

  • Download URL: novemberff-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 68.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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30e9baf9a7e3794dd5373bedd1b6c9a8bc262d1b23e5294c33c2c54f689e81ea
MD5 4d3a1619e8d25d62703226fb3c5f1386
BLAKE2b-256 dfc8a614b97d3faed5eb55039739459b15cafabb236ae5cc19163e75a0331ae6

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