Installation Reference

Linux/Mac Software Dependencies

  • nucypher supports Python 3.7 and 3.8. If you don’t already have it, install Python.

  • Before installing nucypher, you may need to install necessary developer tools and headers:

    - libffi-dev
    - python3-dev
    - python3-pip
    - python3-virtualenv
    - build-essential
    - libssl-dev
    

Pip Installation and Update

In order to isolate global system dependencies from nucypher-specific dependencies, we highly recommend using python-virtualenv to install nucypher inside a dedicated virtual environment.

For full documentation on virtualenv see: https://virtualenv.pypa.io/en/latest/:

  1. Create a Virtual Environment

    $ python -m venv /your/path/nucypher-venv
    ...
    

    Activate the newly created virtual environment:

    $ source /your/path/nucypher-venv/bin/activate
    ...
    $(nucypher-venv)
    

    Note

    Successful virtualenv activation is indicated by (nucypher-venv)$ prepended to your console’s prompt

  2. Install/Update Application Code with Pip

    (nucypher-venv) pip3 install -U nucypher
    
  3. Verify Installation

    Before continuing, verify that your nucypher installation and entry points are functional.

    Activate your virtual environment:

    user@ubuntu$ source /your/path/nucypher-venv/bin/activate
    

    Next, verify nucypher is importable. No response is successful, silence is golden:

    python -c "import nucypher"
    

    Then, run the nucypher --help command:

    (nucypher) user@ubuntu$ nucypher --help
    ...
    

    If successful you will see a list of possible usage options (--version, -v, --dev, etc.) and commands (status, ursula, etc.).

Docker Installation and Update

  1. Install Docker

  2. (Optional) Follow these post install instructions: https://docs.docker.com/install/linux/linux-postinstall/

  3. Get the latest nucypher image:

docker pull nucypher/nucypher:latest