Welcome to vamdclib’s documentation!¶
Contents:
This document covers the release 0.1 of the python library vamdclib.
Links to HTML-versions:
Links to PDF-versions:
Introduction¶
About VAMDC¶
The Virtual Atomic and Molecular Data Center is a EU FP7 research infrastructure project. A comprehensive documentation about the project, standards and related software can be found on the official webpage http://vamdc.eu/.
About this library¶
This library contains several modules that implement access to VAMDC’s infrastructure. It allows to query the central registry service to obtain information about registered VAMDC database nodes and to send queries to these nodes as well as to process the retrieved data. The data is made available as python dictionaries. Tools to store and manage the data in a local sqlite3 database or basex - xml database are included.
The Node - Module¶
About¶
Information about registered VAMDC nodes are stored in the VAMDC registry service. The registry contains a list of all registered database nodes and their url’s.
More information on the VAMDC registry service can be found in the documentation for the VAMDC standards: http://www.vamdc.eu/documents/standards/registry/
Library Classes and Methods¶
Example:¶
The following example shows how to get an node instance for CDMS:
>>> import nodes
>>> nl = nodes.Nodelist()
>>> cdms = nl.getnode('ivo://vamdc/cdms/vamdc-tap-dev')
>>> cdms.url
u'http://cdms.ph1.uni-koeln.de/cdms/tap/'
The ‘getnode’ method can be replaced by findnode if the ‘searchstring’ is unique:
>>> nl.findnode ('CDMS')
The Request - Module¶
About¶
Library Classes and Methods¶
Examples¶
>>> import request
>>> req = request.Request()
>>> req.setnode(cdms)
>>> req.setquery("Select Species")
>>> result = req.dorequest()
req contains now an instance of the Request class. The database CDMS is selected (see example in nodes.py) and a query which selects all species avaialable at the CDMS database is formulated. The last command performs the request and returns an instance of results.Result which contains the return raw xml string and the data parsed into dictionaries whose layout has been defined in spectmodel.py
The Database - Module¶
About¶
Library Classes and Methods¶
Examples¶
>>> import database
>>> db = database.Database()
VAMDC Glossary¶
- VAMDC nodes
A “node” within VAMDC is a data service that offers its data using the standards and protocols defined by the VAMDC. They are web services with a simple API, the specification of which can be found in the documentation for the VAMDC standards: http://vamdc.org/documents/standards/
- VAMDC central registry service
The registry service contains the list of VAMDC nodes and the capabilities of each node.
Bugs and Contact¶
Report a bug¶
The vamdclib library is in active development and there are some rough edges still. We very much appreciate your feedback and complaints are usually resolved quickly.
Please file an issue at https://github.com/VAMDC/vamdclib/issues
This can be used for bugs on both, the software itself and the documentation.
Contact information¶
You can write to the VAMDC developers email list: vamdc.developer <AT> sympa.obspm.fr