ESD Documentation

Welcome to the ESD team documentation hub for Python packages, APIs, and command line tools.

Getting Help

For questions or bug reports, contact #esd-tech-help

Python Requirements

For Python libraries, Python 3.10+ is required. Python 3.11+ is recommended for new projects to align with team standards.

Tools & LibrariesAPIs

General Interest

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
Reviewer Matrix - Building reviewer matrices. API based, formatted output.

Developer Libraries

Dimensions API Client - API client that does not rely on Dimcli. Supports concurrent requests and pagination.
Dimensions Metadata Client - For retrieving metadata for a known set of document ids from Solr or the Dimensions API.
ds-app-cache - Caching library for deployed applications. Supports multiple backends, including Redis.
ds-deploy - For deploying dashboards or web applications.
Dash Support Tools - Dashboard framework utilities.
ds-table - A table component with custom cell rendering functionality. Designed to integrate stylistically with Dimensions out of the box.
esd-dashboard-orchestrator - For building pipelines from Dimensions delayed docsets.
esd-dash-ct - Visualizations for clinical trials dashboards.
esd-text-svmclassifier - CLI for rapidly building/prototyping text-only machine learning models to classify texts with labels.
auto-taxonomy - A package to generate coded data and train classifiers from arbitrary taxonomies

Available APIs

Updating Documentation

To update this documentation, see the repository README for contribution guidelines and follow our GitHub-based workflow for submitting changes.