How elsci-io/peaksel-sdk works
Peaksel SDK is a Python client for uploading and managing chromatography data and retrieving parsed signals and spectra from the Peaksel service. The principal workflow is for an application to use the SDK to upload raw injection files, retrieve injection and chromatogram data, and fetch binary trace or spectrum data for custom processing. Other client modules cover batches, substances, peaks, organizations, and users; optional integrations support matchms and mocca. The sampled clients call the shared HTTP wrapper, while the blob client also uses a cache and decodes binary responses. The tree and excerpts do not establish all facade wiring or the details of unsampled clients, so those links are omitted.
Main entry points: HttpClient.py HTTP client · BlobClient.py Blob client · InjectionClient.py Injection client · ChromClient.py Chromatogram client
Components 18
SDK entry
- Peaksel facade
python/src/peakselsdk/Peaksel.py
Transport and data
- HTTP client
python/src/peakselsdk/HttpClient.py - Blob cache
python/src/peakselsdk/util/CacheManager.py - Blob client
python/src/peakselsdk/blob/BlobClient.py - Binary decoding
python/src/peakselsdk/blob/blobs.py - Spectrum models
python/src/peakselsdk/blob/Spectrum.py
Chromatography data
- Injection client
python/src/peakselsdk/injection/InjectionClient.py - Injection models
python/src/peakselsdk/injection/Injection.py - Chromatogram client
python/src/peakselsdk/chromatogram/ChromClient.py - Detector run models
python/src/peakselsdk/dr/DetectorRun.py
Data management
- Batch client
python/src/peakselsdk/batch/BatchClient.py - Substance client
python/src/peakselsdk/substance/SubstanceClient.py - Peak client
python/src/peakselsdk/chromatogram/peak/PeakClient.py - Organization client
python/src/peakselsdk/org/OrgClient.py - User client
python/src/peakselsdk/user/UserClient.py
Integrations
- Analysis integrations
python/src/peakselsdk/integrations/matchms.py
Other components
- Client application
- Peaksel service
Connections 14
- Client application → Peaksel facade: uses SDK
- Injection client → HTTP client: uploads and queries
- Chromatogram client → HTTP client: posts chromatograms
- Batch client → HTTP client: queries and reassigns
- Substance client → HTTP client: posts substances
- Peak client → HTTP client: posts peaks
- Organization client → HTTP client: queries and creates
- User client → HTTP client: fetches user
- Blob client → Blob cache: reads and writes
- Blob client → HTTP client: fetches blobs
- Blob client → Binary decoding: decodes signals
- Blob client → Spectrum models: parses spectra
- HTTP client → Peaksel service: sends requests
- Analysis integrations → Client application: optional analysis