Skip to main content

An API for ATB

Project description

atb_api

GitHub Actions Build Status codecov

This API is a re-write of the UQ version in Python 2.7

This is a work in progress. It is for Lily's personal use, so not all features of the old API are supported yet. Please open an issue on the Issue tracker if you notice a bug or need a feature.

Example

You will need a valid ATB token to use this API. Please email the ATB administrators to request a token.

Create an instance by passing an API token, or the filename of one:

    api = ATBApi(api_token="MY_TOKEN")

Submit a molecule by passing in a PDB string or filename:

    molid = api.submit_molecule(my_pdb_file.pdb, net_charge=0, molecule_type="heteromolecule")
    assert isinstance(molid, int)

Get a molecule with a molecule ID:

    molecule = api.get_molecule(molid=molid)
    print(molecule.atoms)
    print(molecule.bonds[0].code)

Download a molecule file with a molecule ID:

    pdb_as_str = api.download_molecule(molid=903922, format="pdb",
                                       resolution="all_atom", optimized=True)

Copyright

Copyright (c) 2022, Lily Wang

Acknowledgements

Many thanks to the original ATB API from Bertrand Caron.

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

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

atb_api-0.0.1.tar.gz (132.9 kB view hashes)

Uploaded Source

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