Setup Guide
🚀 Quick Start
For Viewing Only
Simply visit AI4SarcopeniaLiteratureDaily to browse the latest papers!
For Local Development
- Clone the repository
git clone https://github.com/aizierjiang/AI4SarcopeniaLiteratureDaily.git cd AI4SarcopeniaLiteratureDaily - Install dependencies
pip install -r requirements.txt - Run a test
python test_local.py - View results
Check
README.mdanddocs/index.md
⚙️ Configuration
Customize Keywords
Edit config.yaml to add your own research topics:
keywords:
"Your Research Topic":
filters: ["keyword 1", "keyword 2", "multi-word phrase"]
Adjust Update Frequency
Papers per topic (default: 15):
max_results: 15 # Increase for more papers
Example Configurations
Focus on specific area:
keywords:
"Surgical AI":
filters: ["Robot-Assisted Surgery", "Surgical Robot",
"Surgical Automation", "Surgical Planning"]
Broad coverage:
keywords:
"Medical AI":
filters: ["Medical AI", "Healthcare AI", "Clinical AI",
"Medical Machine Learning", "Healthcare ML"]
🔧 Advanced Setup
GitHub Actions (Automatic Updates)
- Fork this repository
- Enable GitHub Actions in Settings
- Grant workflow write permissions
- The workflow runs automatically every 24 hours!
GitHub Pages Deployment
- Go to Settings → Pages
- Source: “Deploy from a branch”
- Branch:
main, Folder:/docs - Save
Your site will be live at: https://yourusername.github.io/
Local Server Testing
For local development with Jekyll:
cd docs
bundle install
bundle exec jekyll serve
Visit http://localhost:4000
📝 Customization Tips
Add New Research Domain
- Edit
config.yaml - Add keywords under a new topic
- Run
python daily_arxiv.py - Papers will appear in a new section
Modify Theme
Edit docs/_config.yml:
color_scheme: dark # or "light"
search_enabled: true
back_to_top: true
Custom Styling
Add CSS to docs/_layouts/papers.html or create custom styles in docs/assets/css/custom.css
🐛 Troubleshooting
No Papers Found
Problem: Script runs but finds no papers
Solution:
- Check internet connection
- Increase
max_resultsin config.yaml - Verify keywords are not too specific
- Try broader search terms
Unicode Errors
Problem: UnicodeEncodeError when writing files
Solution: Already fixed! All file operations use UTF-8 encoding
SSL Errors
Problem: SSL errors when fetching code links
Solution: Already handled! Script continues even if code link fetch fails
GitHub Actions Not Running
Problem: Workflow doesn’t execute
Solution:
- Check Actions tab for errors
- Verify workflow permissions (Settings → Actions)
- Ensure workflows are enabled
- Check cron syntax is correct
📊 Performance Optimization
For Large Datasets
max_results: 10 # Reduce for faster execution
For Specific Topics Only
Comment out topics in config.yaml:
keywords:
# "Topic to skip":
# filters: ["..."]
"Active Topic":
filters: ["keyword 1", "keyword 2"]
Caching Strategy
The project uses JSON files to cache results. To clear cache:
rm docs/*.json
python daily_arxiv.py
📚 Additional Resources
Need more help? Open an issue or discuss.