Installation Guide¶

This guide covers the setup of the necessary environment and installation of the Abacus library.

Prerequisites¶

Clone the Repository (If necessary): If you haven’t already, clone the Abacus repository to your local machine:

git clone <repository_url> # Replace <repository_url> with the actual URL
cd ABACUS # Or your repository directory name

Create a Virtual Environment: It’s highly recommended to use a virtual environment to manage dependencies. Navigate to the project’s root directory (/home/user/Desktop/ABACUS) in your terminal and run:
```
python -m venv venv_abacus
```
Activate the Virtual Environment:
- Linux/macOS:
```
source venv_abacus/bin/activate
```
- Windows (Command Prompt/PowerShell):
```
venv_abacus\Scripts\activate
```
Your terminal prompt should now indicate that you are in the (venv_abacus) environment.
Install Dependencies: Install the core library and its dependencies:
```
pip install -e .
```
The -e flag installs the package in “editable” mode, meaning changes you make to the source code are immediately reflected when you run the library.
Install Development Dependencies (Optional but Recommended): For running tests, building documentation, or contributing to development, install the development dependencies:
```
pip install -e .[dev]
```
This includes tools like pytest, sphinx, mypy, ruff, etc.

After installation, you should be able to import the abacus package in a Python interpreter started from within the activated virtual environment:

import abacus
print("Abacus installed successfully!")

You are now ready to configure and run the model! See the Quickstart Guide.