Welcome to SciPhyx: Your Data Management Tool

SciPhyx is a desktop application designed to help you manage and process your scientific data efficiently. This tutorial will guide you through the key features and functionalities of SciPhyx.

Table of Contents

Introduction

SciPhyx provides a user-friendly interface for organizing, tagging, and processing various types of data files. It leverages Electron for cross-platform compatibility, Svelte for a reactive UI, and TypeScript for robust code.

Setting Up SciPhyx

Installation

Follow these steps to install SciPhyx:

  1. Download the appropriate installer for your operating system from the official SciPhyx website.
  2. Run the installer and follow the on-screen instructions.
  3. Once installed, launch SciPhyx from your applications menu.

Importing Data

Selecting Files and Directories

To import data into SciPhyx:

  1. Navigate to the "Import" page.
  2. Use the file picker to select individual files or choose a directory containing your data. SciPhyx supports various file types, including PDF, TXT, CSV, JPG, PNG, and Python scripts.
  3. SciPhyx uses the `defaultFileOperators` (src/renderer/src/lib/files/index.ts:97-105) to determine how to handle each file type.

Tip: You can import data from local directories, Google Drive, Dropbox, and Amazon S3.

AI Integration (Not yet implemented)

Configuring the AI Agent (Not yet implemented)

SciPhyx integrates with AI models to enhance data processing. To configure the AI agent:

  1. Go to the settings page.
  2. Locate the AI configuration section.
  3. Enter your API keys for the desired provider (e.g., OpenAI).
  4. Select the provider and model you want to use.
  5. SciPhyx uses the `configAgent` function (src/renderer/src/env.d.ts:42-46) to configure the AI agent.

Generating Text with AI (Not yet implemented)

Once the AI agent is configured, you can use it to generate text:

  1. Enter a prompt or message.
  2. Use the `generateText` function (src/renderer/src/env.d.ts:47-48) to send the prompt to the AI model.
  3. The generated text will be displayed in the application.

File Operators

Understanding File Operators

File operators define how SciPhyx processes different file types. Each file type is associated with a specific operator.

You can also create your own python operators by pip installation of the operator package.

SciPhyx uses the `defaultFileOperators` (src/renderer/src/lib/files/index.ts:97-105) to determine which operator to use for each file type.

PDF File Operator

The PDF file operator extracts metadata from PDF files, including title, author, and DOI. It uses the `getArticleInfo` function (src/main/operators/files/pdf.ts:219-260) to retrieve article information from online sources.

Managing Data Entries

Viewing Data Entries

SciPhyx stores processed data as data entries. You can view and manage these entries in the explorer page.

Tagging Data Entries

Tagging data entries helps you organize and categorize your data. You can add custom tags to each entry.

Configuring Settings

General Settings

In the settings page, you can configure various aspects of SciPhyx, including theme, watched directories, and file operators.

Project Settings

You can create and manage projects in SciPhyx. Each project has its own settings, including watched directories and tag definitions.

Thank you for using SciPhyx! We hope this tutorial has been helpful. For more information, please visit our website or contact our support team at info@entrophyx.com .