Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shashvatshah9/arxiv_pilot
https://github.com/shashvatshah9/arxiv_pilot
neo4j streamlit
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/shashvatshah9/arxiv_pilot
- Owner: shashvatshah9
- Created: 2024-03-23T16:42:39.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-24T19:13:40.000Z (9 months ago)
- Last Synced: 2024-11-03T08:42:01.234Z (about 2 months ago)
- Topics: neo4j, streamlit
- Language: Jupyter Notebook
- Homepage:
- Size: 1.45 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PaperLink
The inspiration for PaperLink came from recognizing the desire for a unified platform that caters to the needs of students, researchers, and organizations in the field of academic research. We saw the pain points faced by individuals and groups in navigating the web for scholarly works & we wanted to create a solution that simplifies this process.
PaperLink is a Streamlit application that helps users discover relevant research papers from the ArXiv website based on their text input. The application fetches data from the ArXiv API, processes the information, and presents the results in an intuitive and user-friendly interface.
## Features
- **Text-based search**: Enter a text query or description of your research topic to find relevant papers.
- **ArXiv data fetching**: The application connects to the ArXiv API to retrieve the latest paper metadata.
- **Relevance ranking**: Papers are ranked based on their relevance to the input text using natural language processing techniques.
- **Interactive results**: Browse through the search results, view paper details, and access links to the full papers on the ArXiv website.
- **Citation management**: Easily copy citation information for the selected papers to include in your research work.
## Installation
To run PaperLink locally, follow these steps:
1. Clone the repository:
```
git clone https://github.com/shashvatshah9/arxiv_pilot
```
2. Navigate to the project directory:
```
cd arxiv_pilot
```
3. Install the required dependencies:
```
pip install -r requirements.txt
```
4. Run the Streamlit application:
```
streamlit run src/app.py
```
5. Open your web browser and visit `http://localhost:8501` to access the ArXiv Paper Finder application.
## Usage
1. Enter a text query or description of your research topic in the provided text input field.
2. Click the "Search" button to initiate the search process.
3. The application will fetch relevant papers from the ArXiv API based on your input text.
4. Browse through the search results displayed on the page.
5. Click on a paper title to view more details, including the abstract and a link to the full paper on the ArXiv website.
6. Use the "Copy Citation" button to easily copy the citation information for the selected paper.
7. Refine your search by modifying the input text and clicking the "Search" button again.
## Configuration
The ArXiv Paper Finder application can be configured by adding .env file
- `OPENAI_API_KEY`: Openai api key
- `NEO_PASS`: Neo4j password
## Contributing
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgements
The PaperLink application relies on the ArXiv API to fetch paper metadata. We would like to acknowledge the ArXiv team for providing access to their valuable dataset.