Developer Guide

Welcome to the Developer Guide for pyremap. This section provides resources and guidelines for contributors.

Coding Standards

• Follow PEP 8 for Python code style.

• Use descriptive variable and function names.

• Write clear and concise docstrings for all public functions and classes.

• Ensure code is compatible with Python 3.8+.

Testing

• Write unit tests for all new features and bug fixes.

• Use the pytest framework for testing.

• Place tests in the pyremap/tests/ directory.

• Run tests locally before submitting changes:

  pytest --pyargs tests
  

Contribution Guidelines

• Fork the repository and create a feature branch for your changes.

• Write clear and concise commit messages.

• Ensure all tests pass before submitting a pull request.

• Include documentation updates for any new features or changes.

• Submit a pull request with a detailed description of your changes.

Additional Resources

• Contribution Workflow
  • Step 1: Fork the Repository
  • Step 2: Clone Your Fork
  • Step 3: Create a Feature Branch
  • Step 4: Use a Worktree (Alternative to Step 3)
  • Step 5: Make Changes
  • Step 6: Commit Your Changes
  • Step 7: Push Your Changes
  • Step 8: Submit a Pull Request
  • Step 9: Address Feedback
  • Additional Resources
• Testing Instructions
  • Running Tests
  • Writing Tests
  • Debugging Failures
  • Additional Resources
• Generating and Previewing Documentation
  • Prerequisites
  • Building the Documentation
  • Previewing the Documentation
  • Notes
• API reference
  • Mesh Descriptors
  • Remapping
  • Polar projections