Skip to main content
Ctrl+K
SpectroChemPy 1.3.2.dev1 documentation - Home SpectroChemPy 1.3.2.dev1 documentation - Home
  • Getting started
  • Guides
  • API
  • Examples
  • About
  • GitHub
  • PyPI
  • Conda
  • Getting started
  • Guides
  • API
  • Examples
  • About
  • GitHub
  • PyPI
  • Conda

Guides

  • Introduction
  • Import and export
    • Import Data in SpectroChemPy
    • Reader catalog
    • Import IR Data
      • Import of OMNIC files
      • Import of Bruker OPUS files
      • Import/Export of JCAMP-DX files
  • Processing
    • Slicing NDDatasets
    • Basic transformations
    • Mathematical operations
    • Filtering, Smoothing and Denoising
    • Baseline corrections
    • Denoising
    • Wavelet denoising
    • Apodization
    • Time-domain offset correction
    • Fourier transformation
    • NMR processing in 1D
    • NMR processing in 2D
    • FTIR interferogram processing
    • Alignment of datasets
  • Analysis and modeling
    • Peak Maxima Finding
    • Peak Analysis Workflow
    • Peak Integration
    • Fitting
    • Pipeline
    • Cross-validation of supervised models
    • Principal Component Analysis
    • Partial Least Squares Regression (PLSRegression)
    • MCR-ALS: Multivariate Curve Resolution with Alternating Least Squares
  • Plotting
    • Plotting Overview
    • Customizing a Plot
    • Plotting Preferences
    • Plot Types
    • Styles
    • Advanced Plotting and Matplotlib Integration
  • Plugins
    • Official plugins
    • NMR plugin
    • Tensor plugin
    • IRIS plugin
    • Carroucell plugin
    • PerkinElmer plugin
    • Experimental plugins
    • Plugin examples
    • Plugin roadmap
  • Using the API
  • Data objects
    • The NDDataset object
    • Units, quantities, and masks
    • Project management
  • Contribute / developer guide
    • Contributing to SpectroChemPy
    • Contributing to the code
    • Contributing to specific parts of the code
      • Adding a Reader
    • Contributing to Documentation
    • Plotting Contributions
    • Plotting Architecture
    • Plugin developer guide
      • Plugin author guide
      • Plugin architecture
      • Plugin accessors
      • Numeric backends
      • Unit contexts
      • Packaging a Plugin
      • Testing a Plugin
      • Plugin API Policy
      • Official plugin architecture notes
      • Plugin architecture map
    • File format references
      • OMNIC file formats
        • Common OMNIC structures
        • OMNIC SPA file format
        • OMNIC SPG file format
        • OMNIC SRS file format
        • SpectroChemPy OMNIC reader mapping
    • Reporting Issues
    • Adding your examples to the gallery
  • Guides
  • Developer’s Guide
  • Adding your examples to the gallery

Adding your examples to the gallery#

If you have any nice examples to add to the SpectroChemPy gallery, they are more than welcome. They will allow other users to see the API in operation.

Examples should demonstrate the public SpectroChemPy API. Prefer helpers such as scp.Coord.linspace, scp.linspace or scp.normal over importing NumPy solely to create arrays. Keep NumPy when the example specifically demonstrates interoperability or when no suitable public equivalent exists. Likewise, prefer dataset.plot(), scp.multiplot() or scp.plot_multiple(), including their output= lifecycle, over direct Matplotlib calls. Keep Matplotlib when the example demonstrates integration or needs a feature the public plotting API does not expose.

There are two ways to do this:

  • Use the discussion forums and attach your files, which we will take into account after revisions, mentioning of course the origin and the possible copyright.

  • Create a pull request: For this operation, if you are a newcomer with the git version system, please refer to the Developer’s Guide section .

previous

Reporting Issues

next

API

Edit on GitHub

© Copyright 2014-2026 Laboratoire Catalyse et Spectrochimie (LCS) — CeCILL-B license.

Built with the PyData Sphinx Theme 0.17.1.