ADSfolio documentation

This guide covers ADSfolio 0.10.0.

ADSfolio (package adsfolio) is a scientific literature workflow suite, desktop PDF library browser, and Python/CLI client for NASA ADS / SciXplorer and connected bibliographic discovery services.

ADSfolio uses the official NASA ADS API for searches, citation exports, metrics, ADS libraries, and journal information. We thank the ADS team for providing these services and their API documentation. ADSfolio is an independent project, not an official ADS application.

Where to start:

• New to the desktop app: read Getting started, then Daily workflows.

• Writing scripts or using a terminal: start at CLI and Python workflows and follow the tutorials in order.

• Looking up a command or function: use the API reference.

Desktop app

• Getting started
  • Install
  • Watch the first run
  • Add your existing folders
  • Identify papers in a batch
  • Review metadata before renaming
  • Find a paper
  • Keep the library current
• Daily workflows
  • Keep ADS fallback enabled
  • Keep a BibTeX file for your paper
  • Watch a folder and rename new papers
  • Make your CV from your publications
• App GUI guide
  • Search the table
  • Settings
  • Version information and updates
  • Library roots and missing PDFs
  • Browsing files and editing metadata
  • CV Generator
  • Custom citation styles
  • Identify and Rename
  • Adding identified PDFs to a remote ADS library
  • Exporting a remote ADS library
  • Duplicate PDFs
  • Merging annotations from another edition
  • Watching library roots
  • Adjust the three panels
  • Keyboard navigation
• My paper is not on ADS
  • Type the DOI or arXiv ID
  • Identify PDFs by their DOI
  • Export BibTeX
  • Add a local reference
  • What ADSfolio keeps
  • Limits
  • Other reference managers

CLI and Python

• CLI and Python workflows
  • Install
  • Configure ADS access
  • Search and export
  • Identify and rename local PDFs
  • Watch, upgrade, and export notes
  • Python client
  • Tutorials
• Tutorial 1: Setup and first search
  • 0) Start with --help
  • 1) Install
  • 2) Run first-time setup
  • 3) First query
  • 4) Control search fields and size
  • 5) Sort and filter
  • 6) JSON output for scripting
  • 7) Override token per command
  • 8) Check rate limits
  • Next
• Tutorial 2: Export and BibTeX
  • 0) Start with --help
  • 1) Export a single bibcode
  • 2) Export multiple bibcodes
  • 3) Save to file
  • 4) Choose format and sort
  • 5) Custom export template
  • 6) Journal name style
  • 7) Typical flow from search to export
  • 8) References outside ADS
  • Next
• Tutorial 3: Library workflows
  • 0) Start with --help
  • 1) List your libraries
  • 2) Inspect one library
  • 3) Export library as BibTeX
  • 4) Watch library and auto-refresh BibTeX
  • 5) Add style and extra BibTeX content during watch
  • 6) Tune status logs
  • Next
• Tutorial 4: PDF workflows
  • 0) Start with --help
  • Prerequisite
  • How identify works
  • 1) Optional: route non-OCR PDFs before identify
  • 2) Identify PDFs and update catalog metadata
  • 3) Rename safely: dry-run then apply
  • 4) Watch a folder for new PDFs
  • 5) Check current state
  • 6) Upgrade arXiv PDFs to published versions
  • 7) Auto-upgrade while watching
  • 8) Push resolved bibcodes to an ADS library
  • 9) Generate Obsidian-friendly notes
  • Next
• Tutorial 5: Operations and troubleshooting
  • 0) Start with --help
  • 1) Configuration commands
  • 2) Daily command map
  • 3) Common issues
  • 4) Safe execution pattern
• Tutorial 6: CV workflows
  • 0) Start with --help
  • 1) Create starter config
  • 2) Minimal cv.yaml example
  • 3) Generate output
  • 4) ADS Custom Author Format
  • 5) Compare styles
  • 6) Output behavior
  • Next
• Tutorial 7: From an ADS query to a document with Python
  • Files
  • Prerequisites
  • Quick Run
  • What the script does
  • Customization points
  • Notes for LaTeX users

API reference

• Python API
• Command-line (CLI) reference
• CV settings reference (cv.yaml)

Project

• Maintaining ADSfolio
• Building the desktop app