Installing the library

Using pip

PySmeQcd is available on PyPI. To install it, run

$ pip install PySmeQcd

From source

To use PySmeQcd from the source code:

  1. Download the source code from GitHub.

$ wget https://github.com/GComitini/PySmeQcd/releases/download/v1.1.0-alpha/PySmeQcd-1.1.0a0.tar.gz

  1. Unpack the archive and cd into the PySmeQcd-1.1.0a0/src directory.

$ tar -xzvf PySmeQcd-1.1.0a0.tar.gz
$ cd PySmeQcd-1.1.0a0/src

  1. Copy the PySmeQcd directory to the main directory of your project.

$ cp PySmeQcd <MY_PROJECT>

Note

PySmeQcd depends on the following Python packages:

  • matplotlib

  • numpy

  • scipy

When using PySmeQcd from source, make sure that you have these dependencies installed.

Using the library

To use the PySmeQcd library:

  1. import the PySmeQcd package into an interactive Python session or into a Python script:

>>> import PySmeQcd

  1. The functions and routines contained in the PySmeQcd package can be accessed by using the point notation:

>>> PySmeQcd.<module_name>.<function_name>()

  1. Alternatively, you can import the submodules you need using from .. import ... For example,

>>> from PySmeQcd import gluon

will make the functions and routines contained in the PySmeQcd.gluon submodule accessible by using the dot notation on gluon:

>>> gluon.<function_name>()

See the examples for practical use-cases or the API Reference for an in-depth description of the available functions.