Installation

From New Environment (Conda)

We highly recommend installing conda or miniconda and creating a new virtual environment to install ucdeconvolve as it reduces the likelihood of version conflicts. We suggest the following conda environment which will be compatible with jupyter notebooks.

conda create -n ucdenv python=3.8 pytables jupyter jupyterlab
conda activate ucdenv
pip install ucdeconvolve

Note

As ucdeconvolve uses HDF files as intermin datastore types, the pytables package must be installed with conda before installing ucdeconvolve to ensure that all underlying hdf5 dependencies are present.

From Existing Environment (Pip)

To install ucdeconvolve using pypi in an existing environment, first ensure that pytables has been installed if you are using an existing conda / virtualenv and that the tables package is present under pip list. Then, simply run the following command to install ucdeconvolve and any other required dependencies.

pip install ucdeconvolve

---

Registration

Create a New Account

Registration for UCDeconvolve is straightforward and can be done either in a notebook environment or terminal. We offer dynamic registration with live user input, or programmatic registration with al fields as an input.

Load the ucdeconvolve package and run the ‘ucd.api.register’ command as shown below. Follow the instructions by inputting the required information at each step.

import ucdeconvolve as ucd

ucd.api.register()

Alternatively, one can perform registration entirely programmatically by invoking the function as follows:

username = "USERNAME"
password = "PASSWORD"
firstname = "FIRSTNAME"
lastname = "LASTNAME"
email = "EMAIL"
institution = "INSTITUTION"

ucd.api.register(
    username = username,
    password = password,
    firstname = firstname,
    lastname = lastname,
    email = email,
    institution=institution
    dynamic = False
)

Account Activation

Upon completion of the initial registration form, you will recieve an email at the address specified with an activation code. Copy the code and paste it back into the waiting input prompt in order to activate your account. Upon account activation, a followup email will be sent with your user API key. This key will also be automatically appended to your working ‘ucd’ module instance.

If you accidentally close the registration function instance prior to adding the activation code, you can still activate your account by invoking the ucd.api.activate command and passing the activation code directly there.

activation_code = "ACTIVATION_CODE"
ucd.api.activate(activation_code)

New Session Authentication

When you start a new python instance, you can authenticate your API by simply calling the ucd.tl.authenticate([token]) function and passing your user access token. It will be appended to your settings module at ucd.settings.token