1. Installation

This guide will help you install the memories-dev framework and set up your environment for working with Earth’s collective memory system.

Requirements

• Python 3.10 or higher

• 8GB RAM minimum (16GB+ recommended)

• CUDA-compatible GPU recommended for computer vision tasks

• Internet connection for accessing remote data sources

1.1. Quick Start

Install memories-dev using pip:

pip install memories-dev

For development installation:

git clone https://github.com/Vortx-AI/memories-dev.git
cd memories-dev
pip install -e ".[docs]"

1.2. Optional Dependencies

For full functionality, install optional dependencies:

pip install "memories-dev[docs]"  # Documentation dependencies
pip install "memories-dev[gpu]"   # GPU support
pip install "memories-dev[all]"   # All optional dependencies

1.3. Building Documentation

To build the documentation:

cd docs
pip install -r requirements.txt
make html     # For HTML documentation

Note

For system-specific dependencies and advanced installation options, please refer to System Dependencies

1.3.1. Installation Methods

There are several ways to install the memories-dev framework, depending on your needs and environment.

1.4. Using pip (Recommended)

The simplest way to install the latest stable release is using pip:

pip install memories-dev

For installing with specific optional dependencies:

# Install with all optional dependencies
pip install memories-dev[all]

# Install with GPU support
pip install memories-dev[gpu]

# Install with visualization tools
pip install memories-dev[viz]

# Install with development tools
pip install memories-dev[dev]

1.5. From Source

To install the latest development version from source:

git clone https://github.com/Vortx-AI/memories-dev.git
cd memories-dev
pip install -e .

1.6. Using Docker

We provide Docker images with all dependencies pre-installed:

# Pull the latest image
docker pull vortxai/memories-dev:latest

# Run a container with GPU support
docker run --gpus all -it vortxai/memories-dev:latest

# Run a container with mounted local directory
docker run -v $(pwd):/app -it vortxai/memories-dev:latest

1.6.1. Environment Setup

1.7. Setting Up API Keys

The memories-dev framework integrates with various external APIs for data acquisition. You’ll need to set up API keys for the services you plan to use:

import os
from dotenv import load_dotenv

# Load API keys from .env file
load_dotenv()

# Or set them directly in your environment
os.environ["SATELLITE_API_KEY"] = "your_satellite_api_key"
os.environ["GIS_API_KEY"] = "your_gis_api_key"
os.environ["LLM_API_KEY"] = "your_llm_api_key"

You can also create a .env file in your project root:

SATELLITE_API_KEY=your_satellite_api_key
GIS_API_KEY=your_gis_api_key
LLM_API_KEY=your_llm_api_key

1.8. GPU Configuration

For optimal performance with computer vision and machine learning tasks, we recommend using a GPU:

1.9. Data Storage Configuration

Configure where and how memories-dev stores data:

from memories.config import configure_storage

# Configure local storage
configure_storage(
    storage_type="local",
    base_path="/path/to/data",
    cache_size_gb=10
)

# Or configure cloud storage
configure_storage(
    storage_type="s3",
    bucket_name="memories-data",
    region="us-west-2",
    cache_size_gb=2
)

1.9.1. Verification

To verify that your installation is working correctly:

import memories

# Print version information
print(f"memories-dev version: {memories.__version__}")

# Run system check
status = memories.system_check()
print(f"System status: {'OK' if status.ok else 'Issues detected'}")

if not status.ok:
    for issue in status.issues:
        print(f"- {issue}")

1.9.2. Troubleshooting

1.10. Common Issues

Issue	Solution
ImportError: No module named 'memories'	Ensure you’ve installed the package correctly. Try pip install --force-reinstall memories-dev.
CUDA/GPU not detected	Check that you have compatible NVIDIA drivers installed. Run nvidia-smi to verify.
Memory errors during processing	Reduce batch sizes or image dimensions in your configuration. Consider using a machine with more RAM.
API connection errors	Verify your API keys and internet connection. Check if the service has usage limits or is experiencing downtime.
Slow performance	Enable caching, use GPU acceleration, or consider distributed processing for large datasets.

1.11. Getting Help

If you encounter issues not covered here:

1. Check the FAQ

2. Search the GitHub Issues

3. Ask a question on the Discussion Forum

4. Join our Discord Community

5. Email us at hello@memories.dev

1.11.1. Next Steps

Now that you have memories-dev installed, you can:

• Follow the Quickstart guide to run your first analysis

• Explore the Examples to see real-world applications

• Learn about the ‘core_concepts’ of the framework

• Configure your ‘data_sources’ for optimal performance

1.11.2. Installation Guide

This guide will help you install Memories-Dev and its dependencies.

1.12. Python Requirements

The package requires Python 3.9 or later. We recommend using a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -U pip setuptools wheel

1.13. Installing from PyPI

Install the package using pip:

pip install memories-dev

For development installation:

git clone https://github.com/Vortx-AI/memories-dev.git
cd memories-dev
pip install -e ".[docs]"

1.14. System Dependencies

For PDF documentation generation with SVG support, you need either librsvg or inkscape:

Using Homebrew:

brew install librsvg  # For rsvg-convert
# or
brew install inkscape  # Alternative

sudo apt-get update
sudo apt-get install librsvg2-bin  # For rsvg-convert
# or
sudo apt-get install inkscape  # Alternative

Using Chocolatey:

choco install librsvg  # For rsvg-convert
# or
choco install inkscape  # Alternative

1.15. Additional Dependencies

For full functionality, install optional dependencies:

pip install "memories-dev[docs]"  # Documentation dependencies
pip install "memories-dev[gpu]"   # GPU support
pip install "memories-dev[all]"   # All optional dependencies

1.16. Building Documentation

To build the documentation:

cd docs
pip install -r requirements.txt
make html     # For HTML documentation
make latexpdf # For PDF documentation (requires LaTeX)