Metadata-Version: 2.4
Name: jupyterlab_research_assistant_wwc_copilot
Version: 0.1.0
Summary: A JupyterLab extension for academic research management and WWC quality assessment
Project-URL: Homepage, https://github.com/adamisom/jupyterlab-research-assistant-wwc-copilot
Project-URL: Bug Tracker, https://github.com/adamisom/jupyterlab-research-assistant-wwc-copilot/issues
Project-URL: Repository, https://github.com/adamisom/jupyterlab-research-assistant-wwc-copilot.git
Author-email: Adam Isom <adam.r.isom@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2025, Adam Isom
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: cognitive-science,education,educational-research,educational-technology,instructional-design,jupyter,jupyterlab,jupyterlab-extension,learning-science,meta-analysis,pedagogy,research,systematic-review,wwc
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Requires-Dist: jupyter-server<3,>=2.4.0
Requires-Dist: matplotlib>=3.7.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: pymupdf>=1.23.0
Requires-Dist: requests>=2.31.0
Requires-Dist: scipy>=1.10.0
Requires-Dist: sqlalchemy>=2.0.0
Requires-Dist: statsmodels>=0.14.0
Provides-Extra: conflict-detection
Requires-Dist: torch>=2.0.0; extra == 'conflict-detection'
Requires-Dist: transformers>=4.30.0; extra == 'conflict-detection'
Provides-Extra: dev
Requires-Dist: jupyterlab>=4; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
Description-Content-Type: text/markdown

# jupyterlab_research_assistant_wwc_copilot

[![Github Actions Status](https://github.com/adamisom/jupyterlab-research-assistant-wwc-copilot/workflows/Build/badge.svg)](https://github.com/adamisom/jupyterlab-research-assistant-wwc-copilot/actions/workflows/build.yml)

A JupyterLab extension for academic research management and WWC quality assessment

📖 **[User Guide](./USER_GUIDE.md)** - Complete guide for using all extension features

This extension provides two main features:

- **Research Library & Discovery Engine** (Stage 1 - ✅ Complete):
  Discover, import, and manage academic papers with Semantic Scholar and
  OpenAlex integration, PDF parsing, and AI-powered metadata extraction
- **WWC Co-Pilot & Synthesis Engine** (Stage 2 - ✅ Complete): Perform
  rigorous WWC quality assessments, meta-analysis, conflict detection,
  subgroup analysis, publication bias assessment, and sensitivity
  analysis across multiple studies

This extension is composed of a Python package named
`jupyterlab_research_assistant_wwc_copilot` for the server extension
and a NPM package named `jupyterlab-research-assistant-wwc-copilot` for
the frontend extension.

## Requirements

- JupyterLab >= 4.0.0
- Python >= 3.9
- Node.js (for development)

### Optional Dependencies

For advanced features:

- **AI Metadata Extraction**: Requires API keys for Claude, OpenAI, or
  local Ollama instance
- **Paper Discovery**: Semantic Scholar and OpenAlex APIs are used for
  paper discovery. OpenAlex is used as an automatic fallback if Semantic
  Scholar fails or is rate-limited. No API keys required for either service.
- **Conflict Detection**: Requires `transformers` and `torch` libraries
  (optional, can be installed separately)

  To install conflict detection support:

  ```bash
  pip install "jupyterlab-research-assistant-wwc-copilot[conflict-detection]"
  ```

  This will install both `transformers` and `torch` (PyTorch). PyTorch
  is required as the backend for running the NLI models.

  **Note**: The first time you run conflict detection, the NLI model
  (`cross-encoder/nli-deberta-v3-base`) will automatically download
  (~500MB-1GB). This makes the first run slower, but subsequent runs
  will be faster as the model is cached.

  **GPU Support**: By default, conflict detection uses CPU. To use GPU
  instead, modify
  `jupyterlab_research_assistant_wwc_copilot/services/conflict_detector.py`
  and change `device=-1` to `device=0` in the pipeline initialization.

## Install

To install the extension, execute:

```bash
pip install jupyterlab_research_assistant_wwc_copilot
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall jupyterlab_research_assistant_wwc_copilot
```

## Troubleshoot

If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:

```bash
jupyter server extension list
```

If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:

```bash
jupyter labextension list
```

## Contributing

For development setup, testing, and contribution guidelines, see the
[Developer Guide](./docs/developer-guide.md).

## AI Coding Assistant Support

This project includes an `AGENTS.md` file with coding standards and
best practices for JupyterLab extension development. The file follows
the [AGENTS.md standard](https://agents.md) for cross-tool
compatibility.

### Compatible AI Tools

`AGENTS.md` works with AI coding assistants that support the standard,
including Cursor, GitHub Copilot, Windsurf, Aider, and others. For a
current list of compatible tools, see
[the AGENTS.md standard](https://agents.md). This project also includes
symlinks for tool-specific compatibility:

- `CLAUDE.md` → `AGENTS.md` (for Claude Code)

- `GEMINI.md` → `AGENTS.md` (for Gemini Code Assist)

Other conventions you might encounter:

- `.cursorrules` - Cursor's YAML/JSON format (Cursor also supports AGENTS.md natively)
- `CONVENTIONS.md` / `CONTRIBUTING.md` - For CodeConventions.ai and GitHub bots
- Project-specific rules in JetBrains AI Assistant settings

All tool-specific files should be symlinks to `AGENTS.md` as the single
source of truth.

### What's Included

The `AGENTS.md` file provides guidance on:

- Code quality rules and file-scoped validation commands
- Naming conventions for packages, plugins, and files
- Coding standards (TypeScript, Python)
- Development workflow and debugging
- Backend-frontend integration patterns (`APIHandler`, `requestAPI()`, routing)
- Common pitfalls and how to avoid them

### Customization

You can edit `AGENTS.md` to add project-specific conventions or adjust
guidelines to match your team's practices. The file uses plain Markdown
with Do/Don't patterns and references to actual project files.

**Note**: `AGENTS.md` is living documentation. Update it when you change
conventions, add dependencies, or discover new patterns. Include
`AGENTS.md` updates in commits that modify workflows or coding
standards.

## Documentation

Comprehensive developer documentation is available in the [`docs/`](./docs/) directory:

### Reference Documentation

- **[Master Plan](./docs/master-plan.md)**: High-level project
  architecture and feature breakdown
- **[JupyterLab Architecture](./docs/jupyterlab-architecture.md)**: Deep
  dive into JupyterLab extension patterns
- **[Getting Started](./docs/getting-started.md)**: JupyterLab core
  development environment setup (for understanding JupyterLab, not this
  extension)

### Key Naming Conventions

- **Python package**: `jupyterlab_research_assistant_wwc_copilot`
  (underscores)
- **NPM package**: `jupyterlab-research-assistant-wwc-copilot` (dashes)
- **Plugin ID**: `jupyterlab-research-assistant-wwc-copilot:plugin`
- **Command IDs**:
  `jupyterlab-research-assistant-wwc-copilot:command-name`
- **API Routes**:
  `/jupyterlab-research-assistant-wwc-copilot/endpoint-name`

For detailed development workflow, see the [Developer Guide](./docs/developer-guide.md).

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.

## Packaging the extension

See [RELEASE.md](RELEASE.md) for release instructions.
