Kiara Documentation
  • Before you begin
    • What is kiara?
    • What can kiara do?
    • What is data orchestration?
    • Key concepts
  • Installation
    • Mac
    • Windows
  • Using kiara
    • Network analysis in jupyter notebook
    • Topic modeling in jupyter notebook
    • in CLI
    • Use case
  • Customisation
    • Creating modules
    • Creating pipelines
  • Troubleshooting
    • Versioning
    • Reporting problems
    • Tips for beginners
Powered by GitBook
On this page
  • Prerequisites
  • Creating and activating an environment
  • Dependencies
  • Install kiara and its plugins
  • Install relevant git repository
  1. Installation

Mac

How to install kiara and its dependencies in a virtual environment for Mac users

Prerequisites

If you haven't already, install the latest versions of:

  • miniconda

  • Git

Tip: We recommend using Homebrew or another package manager for installing these.

Creating and activating an environment

Open a new Terminal window and create an environment to install kiara into. For example:

conda create -n kiara_explore

Activate the conda environment:

conda activate kiara_explore

Dependencies

Use conda to install the necessary packages. For the network analysis modules, you will need networkx:

conda install networkx

For the topic modelling modules, you will need...

Install kiara and its plugins

Use pip to install kiara:

pip install kiara

The installation may take a few minutes. Once complete, install kiara's plugins:

pip install kiara_plugin.core_types kiara_plugin.onboarding kiara_plugin.tabular

Tip: to check which version of kiara or any of its plugins are installed at any point, use pip list | grep kiara

Install relevant git repository

For the network analysis modules, use:

pip install git+https://github.com/...

For the topic modelling modules, use:

pip install git+https://github.com/...

To check that the modules are successfully installed and see what operations are possible, use:

kiara operation list
PreviousKey conceptsNextWindows

Last updated 1 month ago