Skip to content

PROJECT_INDEX.md

Latest commit

 

History

History
462 lines (350 loc) · 14 KB

PROJECT_INDEX.md

File metadata and controls

462 lines (350 loc) · 14 KB

MTC Patent Analytics Toolkit - Project Index

Last Updated: July 26, 2025
Repository: mtc-patent-analytics
Branch: main

📊 Quick Navigation

🏗️ Production Platforms

  • PizNet → Full-featured patent intelligence platform
  • PatIntelli → Patent intelligence framework with data provider abstractions
  • IPC Tree Explorer → Modern web-based classification browser

📱 Analysis Applications

🧑‍🎓 Learning & Training

🏗️ Production Platforms

PizNet

Path: /piznet/
Status: Production-ready
Type: Full-featured Python package

Description: Comprehensive patent intelligence platform with modular architecture

Key Features:

  • 185+ Python source files with complete test suite
  • Analyzers: technology, regional, applicant, and trend analysis
  • Data access: PATSTAT, EPO OPS, IPC/CPC, geographic providers
  • Visualizations: charts, maps, dashboards with factory pattern
  • YAML-driven configuration system
  • CLI interface: python patent_intelligence.py

Installation:

cd piznet/
pip install -e .
python patent_intelligence.py --help

Documentation:

PatIntelli

Path: /patintelli/
Status: Active development
Type: Data provider framework

Description: Patent intelligence framework with unified data provider interface

Key Features:

  • Modular analyzer and processor architecture
  • Configuration-driven analysis workflows
  • Multiple data provider abstractions
  • Real connection testing and validation
  • CLI interface: python patent_intelligence.py

Installation:

cd patintelli/
pip install -r requirements.txt
python patent_intelligence.py

Documentation:

IPC Tree Explorer

Path: /ipc-tree-explorer/
Status: Production-ready
Type: Svelte web application

Description: Modern interactive classification hierarchy explorer

Key Features:

  • SvelteKit framework with TailwindCSS
  • Real-time IPC/CPC classification switching
  • Radial tree and Sankey flow visualizations
  • Performance-optimized for 15,000+ nodes
  • Circle packing and interactive exploration modes

Installation:

cd ipc-tree-explorer/
npm install && npm run dev

Documentation:

📱 Analysis Applications

DeepTechFinder

Path: /deeptechfinder/
Status: Production-ready
Type: University analysis toolkit

Description: German university patent analysis using EPO Deep Tech Finder data

Key Features:

  • Complete CLI application with ETL pipeline
  • University-specific analysis and reporting
  • EPO OPS API integration with authentication
  • Legacy notebooks with visualization results
  • CSV data processing and export capabilities

Key Insights:

  • Working EPO OPS configuration for German university patents
  • Application vs. publication number handling
  • Leading zero preservation for older patents

Documentation:

REE Analysis

Path: /ree_analysis/
Status: Active development
Type: Specialized analysis toolkit

Description: Comprehensive Rare Earth Elements patent landscape analysis

Key Features:

  • Structured development phases from templates to live demos
  • Citation network analysis and geographic intelligence
  • Market data correlation and business intelligence
  • Multiple trial runs with complete documentation
  • Integration with USGS market data

Analysis Phases:

  1. Templates (3-livedemo-template/) - Base notebook templates
  2. Live Demos (4-livedemo*/) - Interactive demonstration notebooks
  3. Enhanced (2-enhanced/) - Advanced analysis workflows

Documentation:

FamilyTree

Path: /familytree/
Status: Stable
Type: Visualization toolkit
Credit: Anonymous EPO Examiner

Description: Patent family visualization and relationship analysis

Key Features:

  • Interactive patent family tree generation
  • Python modules for family processing
  • Visual examples of complex structures
  • Helper utilities for tree creation
  • Dependency installation scripts

Documentation:

RegionalMappings

Path: /regionalmappings/
Status: Demonstration-ready
Type: Geographic analysis toolkit
Presented: EPO Patent Knowledge Forum 2024

Description: Geographic patent distribution analysis with NUTS integration

Key Features:

  • NUTS region integration with district-level analysis
  • Interactive maps using PyGWalker
  • Federal state comparison tools
  • Custom visualization configurations
  • German patent data specialization

Key Notebooks:

  • patentknowledgeforum2024.ipynb - Main presentation notebook
  • notebooks/patstat_nuts_de*.ipynb - German NUTS analysis

Documentation:

  • Regional analysis methodology
  • NUTS mapping integration
  • PyGWalker configuration examples

🧑‍🎓 Learning & Training

Training

Path: /training/ & /input/TIP_Notebooks/
Status: Educational resources
Type: Comprehensive training ecosystem
Credit: EPO and WIPO

Description: 80+ educational notebooks covering all aspects of patent analytics

Training Categories:

PATSTAT In-Depth

  • Path: input/TIP_Notebooks/patstat_in_depth/
  • Content: Complete table-by-table documentation
  • Scope: 30+ TLS tables, 25+ REG tables
  • Focus: Database structure and query patterns

EP Fulltext Analysis

  • Path: input/TIP_Notebooks/training_code_ep_fulltext/
  • Content: European patent full-text analysis tutorials
  • Notebooks: 4 main tutorials + exercises
  • Focus: Text mining and content analysis

PATSTAT Basics

  • Path: training/patstat/
  • Content: Fundamental PATSTAT tutorials
  • Notebooks: 4 progressive tutorials
  • Focus: Basic database operations

Specialized Training

  • EPAB: EPO Patent Analytics Bootcamp materials
  • OEPM: Spanish Patent Office gender analysis examples
  • WIPO Handbook: Complete R-based patent analytics guide

Documentation:

  • Comprehensive README files in each training directory
  • Step-by-step tutorial progression
  • Exercise notebooks with solutions

PATLIB

Path: /patlib/
Status: Demonstration archive
Type: PATLIB staff tools

Description: Extensive archive of demonstration materials and trial runs

Key Features:

  • 100+ archived trial runs with complete documentation
  • REE analysis demonstrations for PATLIB staff
  • Enhanced notebooks for market intelligence
  • Business intelligence and geographic analysis pipelines
  • Session transcripts and development logs

Archive Structure:

  • Current trials: trial_run_*_*/ - Timestamped development sessions
  • Enhancements: enhancements/ - Advanced analysis workflows
  • Documentation: Complete session archives and error solutions

Documentation:

🔧 Classification Tools

IPC Browser

Path: /ipc-browser/
Status: Stable
Type: SQLite-based browser
Credit: Tatjana, Johnny, Marc

Description: Interactive IPC classification database with Plotly visualizations

Key Features:

  • SQLite storage for IPC 2025 scheme
  • Database building utilities
  • Interactive tree exploration
  • Plotly-based visualizations

Key Files:

  • patent-classification-2025.db - SQLite database
  • ipc_database_builder.ipynb - Database creation
  • ipc_plotly_visualization.ipynb - Visualization examples

IPC OPS

Path: /ipc-ops/
Status: Stable
Type: API integration toolkit

Description: EPO OPS API integration for IPC data querying

Key Features:

  • Authentication utilities and API access
  • Interactive tutorial notebooks
  • Python modules for automated analysis
  • Environment-based credential management

Key Files:

  • auth.py - Authentication utilities
  • ipc_query.py - Query implementation
  • ipc_query_interactive_tutorial.ipynb - Tutorial

IPC PATSTAT

Path: /ipc-patstat/
Status: Stable
Type: PATSTAT integration

Description: PATSTAT-based IPC analysis with statistical workflows

Key Features:

  • IPC subclass analysis and trends
  • Classification distribution mapping
  • Technology trend visualization
  • PATSTAT Global integration

Key Files:

  • IPC_Subclass_Analysis.ipynb - Main analysis notebook
  • output/ - Generated analysis results

Fun with IPC

Path: /funwithipc/
Status: Experimental
Type: Exploration tools

Description: Experimental IPC classification exploration utilities

Key Features:

  • Interactive classification browsing
  • Exploratory analysis notebooks
  • Classification experimentation tools

📚 Input Data & Resources

REE Material

Path: /input/REE_Material/
Type: Research data and market reports

Contents:

  • Market reports and analysis (PDFs)
  • PATSTAT Spring 2025 REE data (Excel)
  • Classification lists and keyword collections
  • Visualization outputs (HTML)
  • Strategic dependency reports

Geographic Mappings

Path: /input/GEO_Mappings/
Type: Geographic reference data

Contents:

  • NUTS_RG_20M_2013_4326.geojson - EU region boundaries
  • nuts_mapping.csv - Region mapping table
  • Geographic reference data for patent analysis

Documentation Collections

Path: /input/
Type: Reference materials

Collections:

  • EPO PATSTAT Handbooks: Official documentation (6 PDFs)
  • CLAUDE Coding: Claude Code documentation (4 PDFs)
  • WIPO Handbook: Complete patent analytics handbook
  • TIP Notebooks: Training and educational materials

🔗 Cross-References & Navigation

By Technology Stack

By Data Source

By Use Case

🚀 Getting Started

For Patent Information Professionals

  1. Start with PizNet for production analysis
  2. Explore IPC Tree Explorer for classification browsing
  3. Review REE Analysis for specialized landscape analysis

For PATLIB Staff

  1. Begin with PATLIB demonstration materials
  2. Use Training materials for education
  3. Explore Regional Mappings for geographic analysis

For Researchers & Academics

  1. Study Training notebooks for methodology
  2. Examine DeepTechFinder for university analysis
  3. Investigate FamilyTree for relationship analysis

For Developers

  1. Review PizNet for modular architecture patterns
  2. Study PatIntelli for data provider abstractions
  3. Examine IPC Tree Explorer for web application development

📋 Quick Reference

Module Type Status Primary Use Case
PizNet Python Package Production Comprehensive patent intelligence
PatIntelli Framework Development Data provider abstraction
IPC Tree Explorer Web App Production Classification browsing
DeepTechFinder Analysis Tool Production University patent analysis
REE Analysis Specialist Tool Development Rare earth elements analysis
FamilyTree Visualization Stable Patent family analysis
Regional Mappings Analysis Tool Demo Geographic distribution
Training Education Stable Learning and skill development
PATLIB Demonstrations Archive Staff training materials
Classification Tools Utilities Stable IPC/CPC analysis

Total Project Scale:

  • 12 specialized modules
  • 200+ Jupyter notebooks
  • 400+ Python files
  • 4 main Python packages
  • 2 web applications
  • 80+ training notebooks

For detailed setup instructions, see individual module README.md and CLAUDE.md files.