Getting Started
Welcome to the ESD team's tools and documentation! Here's how to get started based on your role:
For Analysts
Start with ds-analyst-tools for data analysis tasks and FAQ for common questions.
Key Tools for Analysis
- ds-analyst-tools - General purpose tools for analysis tasks. To/from GBQ, Solr, large file sharing, GBQ extractor.
- ds-data-vis - For generating data visualizations.
- ds-metrics - Library for computing common bibliometric indicators.
- ds-clustering - Library for clustering document vectors and other forms of data
- ds-label - Library for generating descriptive labels for clusters of documents
For Developers
For step-by-step guidance, see our detailed setup documentation:
- Setup Guide - Comprehensive development environment setup
- Dashboard Setup and Dashboard Development - Dash applications development guide
- Package Development - Python packages setup
Key Developer Tools
- Dimensions API Client - API client that does not rely on Dimcli. Supports concurrent requests and pagination.
- ds-deploy - For deploying dashboards or web applications.
- ds-app-cache - Caching library for deployed applications. Supports multiple backends, including Redis.
- ds-table - A table component with custom cell rendering functionality. Designed to integrate stylistically with Dimensions out of the box.
For API Users
Browse the APIs section below for available endpoints and authentication details.
Available APIs
- Autocomplete API - Search suggestions and autocompletion
- Citation Resolver API - Citation resolution and formatting
- People Matcher - Author disambiguation and people matching
- Topics - Topic classification and analysis
Getting Help
- General Questions: FAQ
- Technical Support: #esd-tech-help Slack channel
- Bug Reports: Use the issue tracker in the respective GitHub repository