Skip to main content

chatgpt for academic

Project description

ChatGPT Academic Optimizer

pypi status python version license precommit black Ruff

A simple web interface for academic research and experimentation using GPT-3.5.

This is the forked version from the project

If you like this project, please give it a star. If you have come up with more useful academic shortcuts, feel free to open an issue or pull request.

Features

  • Automatic paper abstract generation based on a provided LaTeX file
  • Automatic code summarization and documentation generation
  • C++ project header file analysis
  • Python project analysis
  • Self-code interpretation and dissection
  • Experimental function template
Function Description
One-click polishing Supports one-click polishing and finding grammar errors in papers
One-click Chinese-English translation One-click Chinese-English translation
One-click code interpretation Can display code correctly and interpret code
Custom shortcut keys Supports custom shortcut keys
Configure proxy server Supports configuring proxy server
Modular design Supports customizable high-order experimental functions
Self-program analysis [Experimental feature] One-click to understand the source code of this project
Program analysis [Experimental feature] One-click to analyze other Python/C++ projects
Reading papers [Experimental feature] One-click to read the full text of a latex paper and generate an abstract
Batch comment generation [Experimental feature] One-click to generate function comments in batches
chat analysis report generation [Experimental feature] Automatically generates summary reports after running
Formula display Can display the tex form and rendering form of the formula at the same time
Image display Can display images in markdown
Supports markdown tables generated by GPT Supports markdown tables generated by GPT
  • New interface
  • All buttons are dynamically generated by reading functional.py, and custom functions can be freely added to free the clipboard
  • Supports markdown tables generated by GPT
  • If the output contains formulas, it will be displayed in both tex and rendering forms at the same time for easy copying and reading
  • Too lazy to look at the project code? Just show off the chatgpt mouth

Usage

Prerequisites

  • OpenAI API key (can be obtained from here)
  • Python 3.9 or higher

Setup

$pip install academic-chatgpt

Run

  1. Set your OpenAI API key and other configurations in chataca.toml or ~/.config/chataca/chataca.toml

The configuration file will locate at current working directory or ~/.config/chataca/. The example of chataca.toml

API_KEY = "sk-zH**********************************************"
API_URL = "https://api.openai.com/v1/chat/completions"
USE_PROXY = false
TIMEOUT_SECONDS = 30
WEB_PORT = 8080
MAX_RETRY = 3
LLM_MODEL = "gpt-3.5-turbo"

If you are in China, you need to set up an overseas agent to use the OpenAI API.

  1. Start the server: chataca

Experimental features

C++ project header file analysis

In the project path area, enter the project path and click on "[Experimental] Analyze entire C++ project (input the root directory of the project)

LaTeX project abstract generation

In the project path area, enter the project path and click on "[Experimental] Read LaTeX paper and write abstract (input the root directory of the project)

Python project analysis

In the project path area, enter the project path and click on "[Experimental] Analyze entire Python project (input the root directory of the project)"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

academic_chatgpt-0.4.1.tar.gz (31.4 kB view hashes)

Uploaded Source

Built Distribution

academic_chatgpt-0.4.1-py3-none-any.whl (36.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page