Skip to main content
Ctrl+K

cellpy 1.0.3 documentation

  • Getting started
    • Installation
    • Setup and configuration
    • Checkup & useful commands
    • Basic usage
  • Fundamentals
    • The fundamentals of cellpy
    • File formats
    • Data structure
  • Examples & tutorials
    • Loading, saving and exporting data
    • Different data formats
    • Defining your own custom loaders
    • Initial data inspection and plotting
    • Capacity vs voltage
    • Incremental capacity analysis (dQ/dV)
    • GITT analysis
    • Batch processing
    • The cellpy templating system
  • Contributing guide
    • Contributing
    • Developers guide
      • Getting ready to develop
      • Main cellpy objects
      • Structure of the cellpy package
      • About loaders
      • Writing documentation
      • Create package for PyPI
      • Create conda package
      • Various
  • Other
    • Credits
    • History
    • MIT License
    • Contributor Covenant Code of Conduct
  • .md

Developers guide

Developers guide#

  • Getting ready to develop
    • Get the code
    • Install python 3.10 or higher
    • Create a development environment
  • Main cellpy objects
    • The CellpyCell object
    • The Data object
    • The cellpy file format
  • Structure of the cellpy package
    • Folder structure
    • Handling of parameters
    • Logging
    • Utilities
  • About loaders
    • Structure of instrument loaders
    • The local_instrument loader
    • The custom loader
  • Writing documentation
    • Types of documentation
    • Add examples to the examples folder
    • Working on the main documentation
    • Tests
  • Create package for PyPI
    • Build package
    • Upload package
  • Create conda package
    • Fork
    • Clone
    • Get recent changes
    • Make a new branch in your local clone
    • Edit
    • Add and commit
    • Push
    • Re-render if needed
    • Pull request and merge
    • Wrap up
  • Various
    • Using pytest fixtures
    • Adding another config parameter
    • Installing pyodbc on Mac without conda

previous

Contributing

next

Getting ready to develop

By Author name not set

© Copyright 2025, Jan Petter Maehlen.