pyissm Documentation

Welcome to the pyISSM documentation!

Warning

This is an experimental release. Documentation remains a work in progress. Some sections may be incomplete or under development.

Quick Links

• Overview - A high-level introduction to pyISSM features and capabilities.

• Installation - Instructions for installing pyISSM.

• Tutorials - Hands-on tutorials demonstrating common pyISSM workflows.

• API Reference - Detailed API documentation for pyISSM submodules and classes.

• Contributing Guidelines - How to contribute to pyISSM development and documentation.

Getting Started

To get started with pyISSM, please refer to the installation guide and the overview section for a comprehensive introduction to the library’s features and capabilities.

Tutorials

For hands-on pyISSM tutorials, please refer to the tutorials section.

Contributing

We welcome contributions from the community! If you’re interested in contributing to pyISSM development or documentation, please check out our contributing guidelines.

Contents:

• Overview
• Installation
  • Installing via pip
  • Installing via conda
  • Installing from GitHub (Development Version)
  • pyISSM conda environment
  • Verifying the Installation
• Tutorials
  • pyISSM introduction
  • Hands-on Tutorials
  • Learning Modules
• pyissm API Reference
  • Model Class
  • Model sub-classes
  • Model operations
  • Tools
  • Data
  • Plot
  • Analysis
• Contributing