Skip to content

README.md

Latest commit

 

History

History
145 lines (107 loc) · 6.73 KB

README.md

File metadata and controls

145 lines (107 loc) · 6.73 KB

Installation Documentation: Setup and Configuration Guides

← Back to Docs | Claude Code → | Basic Installation →

Directory Structure

installation/
├── README.md                       # This file - installation documentation hub
├── BASIC_INSTALLATION.md           # Standard pip installation guide
├── GETTING_STARTED.md              # First steps after installation
├── TROUBLESHOOTING.md              # Platform-specific troubleshooting
├── VIRTUAL_ENVIRONMENTS.md         # Virtual environment setup guide
├── JUPYTER_SETUP.md                # Jupyter notebook configuration
├── DEVELOPER_SETUP.md              # Development environment setup
├── USING_GIT.md                    # Git tutorial and GitHub workflow
├── CLAUDE_CODE.md                  # AI-assisted installation with Claude Code
└── CLAUDE_TEMPLATE.md              # Claude Code project templates

Overview

This directory provides comprehensive installation guides for the ModelChecker framework, organized by use case to help users quickly find the information they need. Each guide focuses on a specific installation scenario, from basic pip installation to full development setup with Jupyter integration.

The documentation covers 7 installation scenarios: AI-assisted installation with Claude Code, standard pip installation, troubleshooting common issues, virtual environment setup, Jupyter notebook configuration, getting started guide, and developer environment setup. This modular approach ensures users can follow only the guides relevant to their needs without navigating unrelated content.

Installation options range from the simple pip install model-checker for basic usage to complete development environments with editable installs and testing frameworks. Special attention is given to platform-specific considerations (Windows, macOS, Linux, NixOS) and Python environment management to ensure successful installation across diverse systems.

Theory Examples

Basic Installation Verification

After installing ModelChecker, verify it's working:

# Test basic import
from model_checker import get_theory

# Load a theory
theory = get_theory('logos')

# Quick validity check
premises = ["A", "A \\rightarrow B"]
conclusions = ["B"]
result = theory.check_validity(premises, conclusions)
print(f"Valid: {not result}")  # Should print: Valid: True

Command-Line Usage

# Verify installation
model-checker --version

# Run an example
model-checker examples/modus_ponens.py

# With specific settings
model-checker examples/test.py --contingent --save json

Development Setup Test

# Clone and install for development
git clone https://github.com/benbrastmckie/ModelChecker.git
cd ModelChecker/Code
pip install -e .

# Run tests
./run_tests.py --unit

For complete examples, see Getting Started.

Subdirectories

This directory contains only installation guide files (no subdirectories). Each guide serves a specific installation need:

Installation Guides

  • BASIC_INSTALLATION.md - Standard pip installation for most users, including prerequisites, installation options, and Python setup
  • GETTING_STARTED.md - First steps after installation, including creating examples, understanding output, and common workflows
  • TROUBLESHOOTING.md - Solutions for platform-specific issues, common errors, and debugging installation problems
  • VIRTUAL_ENVIRONMENTS.md - Creating isolated Python environments for clean installations and project management
  • JUPYTER_SETUP.md - Configuring Jupyter notebooks with widgets for interactive ModelChecker development
  • DEVELOPER_SETUP.md - Complete development environment with editable installs, testing setup, and contribution preparation
  • USING_GIT.md - Git tutorial and GitHub workflow for version control beginners
  • CLAUDE_CODE.md - AI-assisted installation using Claude Code CLI - recommended for beginners and automated setup with GitHub integration
  • CLAUDE_TEMPLATE.md - Project templates for Claude Code users

Documentation

For New Users

For Jupyter Users

For Developers

Key Features

Multiple Installation Methods

  • AI-Assisted: Use Claude Code to automate the entire process - recommended for beginners
  • Standard: pip install model-checker - Basic installation
  • Jupyter: pip install model-checker[jupyter] - With notebook support
  • All: pip install model-checker[all] - Everything included
  • Development: Editable install from cloned repository

Platform Support

  • Windows - Special considerations for py vs python
  • macOS - Certificate updates and Homebrew options
  • Linux - Distribution-specific package managers
  • NixOS - Declarative shell.nix configuration

Environment Management

  • Virtual environment creation and activation
  • Jupyter kernel registration
  • Requirements file generation
  • Clean uninstallation procedures

References

Installation Resources

Related Documentation

← Back to Docs | Claude Code → | Basic Installation →