Skip to content

Latest commit

 

History

History
124 lines (98 loc) · 2.85 KB

installation.md

File metadata and controls

124 lines (98 loc) · 2.85 KB

Installation

This guide will help you set up EMScribe 2.0 on your local machine.

Prerequisites

Before you begin, ensure you have the following:

  • Python 3.8 or higher
  • Virtual Environment (venv)
  • Ollama (running locally)
  • VS Code (or any IDE)
  • Git

Clone the Repository

First, clone the EMScribe 2.0 repository from GitHub to your local machine.

git clone <repository_url>
cd EMScribe

Set Up a Virtual Environment

Next, set up a virtual environment to manage dependencies. This helps to avoid conflicts with other projects.

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Install Dependencies

With the virtual environment activated, install the required Python packages.

pip install -r requirements.txt

Configure Ollama

Ensure that Ollama is running locally and accessible at http://localhost:11434.

Starting Ollama

Refer to Ollama's documentation to start the server locally. Ensure it is running and accessible before proceeding.

Directory Structure

Here is an overview of the EMScribe 2.0 directory structure after installation:

.
|-- README.md
|-- bin
|   `-- emscribe
|-- commands
|   |-- clean_command.py
|   |-- extract_command.py
|   |-- generate_command.py
|   `-- review_command.py
|-- data
|   |-- cleaned_transcript.txt
|   |-- extract.txt
|   |-- narrative.txt
|   `-- reviewed_extract.txt
|-- docs
|   |-- api_reference.md
|   |-- contributing.md
|   |-- development.md
|   |-- index.md
|   |-- installation.md
|   `-- usage.md
|-- images
|   `-- emscribe_logo.png
|-- modules
|   |-- extract_reviewer.py
|   |-- model_loader.py
|   |-- narrative_manager.py
|   |-- prompt_manager.py
|   |-- prompts
|   |   |-- cleaning_prompts.py
|   |   |-- extraction_prompts.py
|   |   |-- narrative_prompts.py
|   |   `-- review_prompts.py
|   |-- transcript_cleaner.py
|   `-- transcript_extractor.py
|-- requirements.txt
|-- scripts
|   |-- cli.py
|   |-- data
|   |   |-- cleaned_transcript.txt
|   |   `-- extract.txt
|   |-- extraction.py
|   |-- main.py
|   `-- preprocess.py
|-- tests
|   |-- conftest.py
|   |-- test_cli.py
|   |-- test_model_loader.py
|   |-- test_review_command.py
|   |-- test_transcript_cleaner.py
|   `-- test_transcript_extractor.py
|-- transcript.txt
`-- venv

Verify the Installation

To verify that everything is set up correctly, run the tests:

pytest

If all tests pass, your installation is successful and you are ready to use EMScribe 2.0.

Next Steps

  • Usage: Learn how to use EMScribe 2.0 for extracting and cleaning transcripts.
  • Development: Understand the development workflow and how to contribute to EMScribe 2.0.
  • API Reference: Detailed information about the API and modules.
  • Contributing: Guidelines for contributing to the project.