Skip to main content

OpenFF NAGL Models

Project description

Open NAGL Models

Latest release Last release tag GitHub commits since latest release (by date) for a branch Documentation Status
Status GH Actions Status

This repository contains NAGL models released by the Open Force Field Initiative. They are intended to be used by OpenFF NAGL.

Use

Installing this package exposes an entry point that makes it easy to access models installed in this package.

A convenience function is provided to wrap this for you:

>>> from openff.nagl_models import load_nagl_model_directory_entry_points
>>> load_nagl_model_directory_entry_points()
[PosixPath('/home/.../openff-nagl-models/openff/nagl_models/models/am1bcc')]

You can also list all available models from all entry points:

>>> from openff.nagl_models import list_available_nagl_models
>>> list_available_nagl_models()
[PosixPath('/home/.../openff-nagl-models/openff/nagl_models/models/am1bcc/openff-gnn-am1bcc-0.0.1-alpha.1.pt'), PosixPath('/home/.../openff-nagl-models/openff/nagl_models/models/am1bcc/openff-gnn-am1bcc-0.1.0-rc.1.pt')]

Or validate if a model name is found in the local directory, or an entry point directory:

>>> from openff.nagl_models import validate_nagl_model_path
>>> validate_nagl_model_path("openff-gnn-am1bcc-0.0.1-alpha.1.pt")
PosixPath('/home/.../openff-nagl-models/openff/nagl_models/models/am1bcc/openff-gnn-am1bcc-0.0.1-alpha.1.pt')

Finally, if you want to find all models for a particular type, use get_models_by type. These will come sorted according to semantic versioning, where the latest release is last:

>>> from openff.nagl_models import get_models_by_type
>>> get_models_by_type("am1bcc")
[PosixPath('/home/.../openff-nagl-models/openff/nagl_models/models/am1bcc/openff-gnn-am1bcc-0.0.1-alpha.1.pt'), PosixPath('/home/.../openff-nagl-models/openff/nagl_models/models/am1bcc/openff-gnn-am1bcc-0.1.0-rc.1.pt')]

Versions

  • v0.0.1-alpha.1: a pre-production model to use for experimentation. We do not recommend using this model to assign charges in scientific work.
  • v0.1.0-rc1: a pre-production model to use to assign AM1-BCC partial charges.
  • v0.1.0-rc2: a pre-production model to use to assign AM1-BCC partial charges.
  • v0.1.0-rc3: a pre-production model to use to assign AM1-BCC partial charges.

Acknowledgements

Project based on the Computational Molecular Science Python Cookiecutter version 1.0.

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

openff_nagl_models-0.3.0.tar.gz (42.5 MB view details)

Uploaded Source

File details

Details for the file openff_nagl_models-0.3.0.tar.gz.

File metadata

  • Download URL: openff_nagl_models-0.3.0.tar.gz
  • Upload date:
  • Size: 42.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for openff_nagl_models-0.3.0.tar.gz
Algorithm Hash digest
SHA256 62a157513a668bf8200932f59b1a5608c08371b63a4c8293ba46b2587385144b
MD5 25cbf108a4b7513777474bafef353bce
BLAKE2b-256 ca9e3866ecca09dc0534efd9ee77b80b33ea7f07c14deb977d9d4241509a3bfe

See more details on using hashes here.

Provenance

Supported by

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