📚
Book Analytics Service
  • 📚Dashboard overview
    • Book Analytics Service
    • How the Dashboard works
    • Dashboard data sources
    • How to use your Dashboard
    • More information and contact us
      • Glossary
      • License
      • Contributing Guide
  • 🖱️Installing BAD Workflows
  • 🔭Workflows & Telescopes
    • Workflow Schedule
    • Data Telescopes
      • Google Analytics Universal
      • Google Books
      • IRUS Fulcrum
      • IRUS OAPEN
      • JSTOR
      • UCL Discovery
      • UCL Sales
    • Metadata Telescopes
      • OAPEN Metadata
      • ONIX
      • Thoth
    • ONIX Workflow
      • Data Partners
      • Schemas
      • Crossref Metadata
Powered by GitBook
On this page
  • Installing System Dependencies
  • Creating a Python Virtual Environment
  • The Observatory Platform
  • BAD Workflows

Installing BAD Workflows

PreviousContributing GuideNextWorkflows & Telescopes

Last updated 4 months ago

Dependencies:

  • Python 3.10

  • pip

  • (recommended)

  • or

See below for more a detailed walk-through of the installation process.

Installing System Dependencies

Update packages list and install software-properties-common:

sudo apt update
sudo apt install software-properties-common

Add deadsnakes PPA which contains Python 3.10 for Ubuntu 20.04; press Enter when prompted:

sudo add-apt-repository ppa:deadsnakes/ppa

Install Python 3.10:

sudo apt install python3.10 python3.10-dev

Install pip:

curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3.10 get-pip.py

Install virtualenv:

pip install --upgrade virtualenv

Install Docker Engine:

  • Following the tutorial.

  • Make sure that Docker can be run without sudo, e.g. sudo usermod -aG docker your-username

Install with the following command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install Python 3.10 with brew:

brew install python@3.10

Add Python 3.10 to path:

echo 'export PATH="/usr/local/opt/python@3.8/bin:$PATH"' >> ~/.bash_profile

Install virtualenv 20 or greater:

pip3.10 install --upgrade virtualenv

Install Docker Desktop:

  • Follow the tutorial.

Creating a Python Virtual Environment

python3.10 -m venv MY_VENV_NAME # Change MY_VENV_NAME to whatever you please

To activate/deactivate the environment:

source MY_VENV_NAME/bin/activate # Activate
deactivate # Deactivate

While active, all changes to Python packages will be contained to the environment. Similarly, any Python run commands will be done in the context of the active environment. It is recommended that the following packages are installed to an active virtual environment, although there is no reason that the BAD Workflows could not be run without one.

The Observatory Platform

Make sure that you have followed the above instructions before installing the observatory-platform.

git clone https://github.com/The-Academic-Observatory/observatory-platform

Install the observatory-platform package:

pip install observatory-platform --constraint https://raw.githubusercontent.com/apache/airflow/constraints-2.7.3/constraints-no-providers-3.10.txt

BAD Workflows

git clone https://github.com/The-Academic-Observatory/oaebu-workflows.git

Install the workflows to the active python environment

pip install oaebu-workflows

It is highly recommended to create a before installing the Observatory Platform and BAD workflows. To create a new virtual environment, execute the following command:

Clone the :

Clone the (oaebu-workflows)

🖱️
Python virtualenv
Docker Engine
Docker Desktop
The Observatory Platform
Install Docker Engine on Ubuntu
Homebrew
Install Docker Desktop on Mac
Python virtual environment
Observatory Platform repository
BAD workflows repository