Wosecopy

User Guide

  • Installation
    • Prerequisites
    • Install from PyPI
    • Install from Source
    • Download Language Models
      • English (Required)
      • German (Optional)
    • Verify Installation
    • Virtual Environment (Recommended)
    • Dependencies
    • Development Installation
    • Troubleshooting
      • Model Not Found
      • Import Error
      • Permission Errors
  • Quick Start Guide
    • Your First Analysis
      • Step 1: Prepare Your Data
      • Step 2: Extract Concepts
      • Step 3: Analyze Results
    • Common Use Cases
      • Analyze by Creativity Ratings
      • Export Graphs for Gephi/Cytoscape
      • Compare Multiple Raters
      • Measure Story Creativity
    • Python API Quick Start
      • Basic Extraction
      • Graph Analysis
      • Visualization
    • Understanding the Output
      • Extracted Concepts
      • Network Metrics
      • Unexpectedness Scores
    • Next Steps
  • CLI Guide
    • Overview
    • Getting Help
    • Common Workflows
      • Basic Analysis Pipeline
      • Research Workflow
    • Command Reference
    • Examples
      • Extract with Custom Settings
      • Export Multiple Formats
      • Batch Processing
    • Tips and Tricks
      • Progress Bars
      • Output Organization
      • Chaining Commands
    • Troubleshooting
      • Model Not Found
      • Column Not Found
      • Empty Results
  • Tutorials
    • Tutorial 1: Basic Concept Extraction
      • Step 1: Prepare Your Data
      • Step 2: Extract Concepts
      • Step 3: Examine Results
    • Tutorial 2: Network Analysis
      • Build and Visualize Graphs
      • Calculate Metrics
    • Tutorial 3: Creativity Analysis
      • Group by Rating
      • Calculate Unexpectedness
    • Tutorial 4: Multi-Rater Analysis
      • Setup Data
      • Statistical Testing
    • Tutorial 5: Batch Processing
      • Process Multiple Files
    • Tutorial 6: Export for Gephi
      • Export Workflow
      • In Gephi
    • Tutorial 7: German Language Support
      • Setup
      • Extract German Concepts
    • Next Steps

API Reference

  • Core Module
    • WosecoExtractor Class
    • Usage Example
    • Key Methods
      • get_concept_matches
      • get_woseco
      • extract_nouns
      • process_csv
  • Graph Module
    • Functions
      • build_graph
      • build_graphs_from_list
      • export_graph
      • export_graphs
      • load_graph
      • merge_graphs
      • get_graph_summary
    • Usage Examples
      • Complete Workflow
      • Analyzing Individual Graphs
  • Metrics Module
    • Network Metrics Functions
      • calculate_aspl
      • calculate_mlcc
      • calculate_modularity
      • calculate_num_components
      • calculate_avg_component_size
      • calculate_gcc_size
    • Aggregate Functions
      • calculate_all_metrics
      • stats
      • aggregate_metrics
      • compare_metrics
    • Complete Example
      • Analyze Stories by Rating
    • Metrics Reference Table
  • Analysis Module
    • Key Functions
      • unexpectedness_arrays
      • group_by_rating
      • compare_raters
      • analyze_prompt_groups
  • Visualization Module
  • Language Module
  • CLI Module
    • Commands Reference
      • extract
      • metrics
      • export
      • visualize
      • analyze-ratings
      • compare
      • unexpectedness
      • download-model

Additional Information

  • Contributing
    • Getting Started
    • Development Setup
      • Install Development Dependencies
      • Download Language Models
    • Code Style
      • Format Code
      • Lint Code
    • Running Tests
      • Run All Tests
      • Run with Coverage
      • Run Specific Test File
      • Run Specific Test
    • Writing Tests
      • Example Test
    • Documentation
      • Build Documentation
      • Writing Documentation
    • Submitting Changes
      • 1. Create a Feature Branch
      • 2. Make Your Changes
      • 3. Commit Your Changes
      • 4. Push to Your Fork
      • 5. Create Pull Request
    • Pull Request Guidelines
    • Code Review Process
    • Types of Contributions
      • Bug Reports
      • Feature Requests
      • Code Contributions
    • Questions?
    • Thank You!
  • Changelog
    • Version 0.1.3 (Initial Release)
      • Features
      • Modules
      • Documentation
      • Testing
      • Known Issues
    • Future Plans
  • License
    • MIT License
Wosecopy
  • Search

© Copyright 2024, Owen Saunders, Edith Haim.

Built with Sphinx using a theme provided by Read the Docs.