Installation Guide

Welcome to the installation guide for Acadia. This page provides detailed instructions on how to install Acadia, including prerequisites and step-by-step installation from the GitHub repository. Although Acadia is not yet available as a pip installable package, you can easily set it up from source.

Prerequisites

Before installing Acadia, you need to ensure that your system meets the following requirements:

• Python: Acadia requires Python 3.6 or newer. You can download Python here (opens in a new tab).

• pip: Ensure that pip is up to date. You can upgrade pip using the following command:

  python -m pip install --upgrade pip

• Git: Git must be installed to clone the repository. You can download it from Git SCM (opens in a new tab).

Installation Steps

1. Clone the Repository

First, clone the Acadia repository from GitHub. Replace https://github.com/dummy/acadia.git with the actual URL of the repository:

git clone https://github.com/dummy/acadia.git
cd acadia

2. Create a Virtual Environment (Optional)

It's a good practice to create a virtual environment for Python projects. This keeps your project's dependencies separate from your global Python environment:

python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install Dependencies

Install all the required dependencies using pip:

pip install -r requirements.txt

4. Set Up the Environment

Before running Acadia, you need to set up the initial environment where Acadia will operate. You can do this by specifying a directory for Acadia data management, which will be used in the initialization step of your projects:

mkdir acadia_data

Running Acadia

After installation, you can start using Acadia by importing it into your Python scripts:

import acadia
acadia.init('path_to_acadia_data')

This initializes the Acadia environment, pointing it to the directory where it will manage its datasets and other data structures.

Updating Acadia

To update Acadia to the latest version, pull the latest changes from the GitHub repository:

git pull origin main
pip install -r requirements.txt  # Re-install dependencies if updated

Next Steps

Now that you have installed Acadia, proceed to the Quick Start guide to begin using Acadia for your data management and analysis tasks.