mmpp 0.5.3__tar.gz

mmpp-0.5.3/.flake8

@@ -0,0 +1,18 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E266, E501, W503, F403, F401, E402
+max-complexity = 25
+exclude = 
+    .git,
+    __pycache__,
+    docs/source/conf.py,
+    old,
+    build,
+    dist,
+    .eggs,
+    *.egg,
+    venv,
+    .venv
+
+per-file-ignores =
+    __init__.py:F401

mmpp-0.5.3/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  # Enable version updates for Python dependencies
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    reviewers:
+      - "mateuszzelent"  # Replace with your GitHub username
+    
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5

mmpp-0.5.3/.github/workflows/auto-format.yml

@@ -0,0 +1,53 @@
+name: Auto Format Code
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - name: Install formatting tools
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff
+
+    - name: Format and lint code with ruff
+      run: |
+        python -m ruff format mmpp/ tests/ scripts/
+        python -m ruff check --fix mmpp/ tests/ scripts/
+
+    - name: Check for changes
+      id: verify-changed-files
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          echo "changed=true" >> $GITHUB_OUTPUT
+        else
+          echo "changed=false" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Commit and push changes
+      if: steps.verify-changed-files.outputs.changed == 'true'
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "GitHub Action"
+        git add -A
+        git commit -m "style: Auto-format code with ruff
+
+        [skip ci]"
+        git push

mmpp-0.5.3/.github/workflows/docs.yml

@@ -0,0 +1,85 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+  actions: read
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Fetch full history for better Git info
+    
+    - name: Setup Pages
+      uses: actions/configure-pages@v5
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    
+    - name: Cache pip packages
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools wheel
+        pip install sphinx sphinx-rtd-theme myst-parser sphinx-autodoc-typehints linkify-it-py
+        # Install package dependencies
+        if [ -f pyproject.toml ]; then
+            pip install -e .
+        elif [ -f requirements.txt ]; then
+            pip install -r requirements.txt
+        fi
+    
+    - name: Build documentation
+      continue-on-error: true
+      run: |
+        cd docs
+        # Ensure build directory exists
+        mkdir -p _build
+        # Copy .nojekyll to build directory
+        if [ -f .nojekyll ]; then
+            cp .nojekyll _build/.nojekyll
+        else
+            touch _build/.nojekyll
+        fi
+        # Build docs without treating warnings as errors and continue on errors
+        sphinx-build -b html . _build --keep-going -q || echo "Documentation built with warnings/errors, but continuing..."
+    
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./docs/_build
+    
+    - name: Deploy to GitHub Pages
+      if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+      id: deployment
+      uses: actions/deploy-pages@v4

mmpp-0.5.3/.github/workflows/release.yml

@@ -0,0 +1,122 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+    inputs:
+      test_pypi:
+        description: 'Upload to TestPyPI instead of PyPI'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11','3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Auto-format code
+      run: |
+        python -m ruff format mmpp/ tests/ scripts/
+        python -m ruff check --fix mmpp/ tests/ scripts/
+    
+    - name: Lint with ruff
+      run: |
+        python -m ruff check mmpp/ tests/ scripts/
+    
+    - name: Type check with mypy
+      run: |
+        python -m mypy mmpp/ --ignore-missing-imports
+      continue-on-error: true
+    
+    - name: Test with pytest
+      run: |
+        python -m pytest tests/ -v --cov=mmpp --cov-report=xml
+      continue-on-error: true
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      if: matrix.python-version == '3.11'
+      with:
+        file: ./coverage.xml
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: python -m build --sdist --wheel
+    
+    - name: Check package
+      run: python -m twine check dist/*
+    
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+  release:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+    - name: Download build artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}
+
+  release-test:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.test_pypi == 'true'
+
+    steps:
+    - name: Download build artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    
+    - name: Publish to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/

mmpp-0.5.3/CONTRIBUTING.md

@@ -0,0 +1,219 @@
+# Contributing to MMPP
+
+Thank you for your interest in contributing to MMPP (Micro Magnetic Post Processing)! We welcome contributions from the community.
+
+## 🚀 Quick Start
+
+### Development Setup
+
+1. **Fork and Clone**
+   ```bash
+   git clone https://github.com/mateuszzelent/mmpp.git
+   cd mmpp
+   ```
+
+2. **Install Development Dependencies**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+3. **Run Tests**
+   ```bash
+   pytest tests/
+   ```
+
+## 📋 Contribution Guidelines
+
+### Code Style
+
+We use several tools to maintain code quality:
+
+- **Ruff** for code formatting and linting
+- **MyPy** for type checking
+
+Run these tools before submitting:
+```bash
+ruff format mmpp/
+mypy mmpp/
+```
+
+### Testing
+
+- Write tests for new features
+- Ensure all tests pass: `pytest tests/`
+- Maintain or improve test coverage
+
+### Documentation
+
+- Update docstrings for new functions/classes
+- Add examples to the documentation
+- Update the README if needed
+
+## 🐛 Reporting Issues
+
+When reporting issues, please include:
+
+- Python version
+- MMPP version
+- Operating system
+- Clear description of the problem
+- Minimal code example to reproduce the issue
+
+## 💡 Feature Requests
+
+Before requesting a feature:
+
+1. Check if it already exists in the [issues](https://github.com/MateuszZelent/mmpp/issues)
+2. Consider if it fits the project scope
+3. Provide a clear use case
+
+## 📝 Pull Request Process
+
+1. **Create a Branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make Your Changes**
+   - Follow the code style guidelines
+   - Add tests for new functionality
+   - Update documentation as needed
+
+3. **Test Your Changes**
+   ```bash
+   pytest tests/
+   ruff check mmpp/
+   ruff format --check mmpp/
+   ```
+
+4. **Commit and Push**
+   ```bash
+   git add .
+   git commit -m "Add: brief description of your changes"
+   git push origin feature/your-feature-name
+   ```
+
+5. **Submit Pull Request**
+   - Use a clear title and description
+   - Reference any related issues
+   - Wait for review and address feedback
+
+## 🏗️ Development Workflow
+
+### Using Just (Recommended)
+
+If you have [just](https://github.com/casey/just) installed:
+
+```bash
+# Setup development environment
+just dev-setup
+
+# Run tests
+just test
+
+# Format code
+just format
+
+# Build documentation
+just docs
+```
+
+### Manual Commands
+
+```bash
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run all tests
+pytest tests/ -v
+
+# Format code
+ruff format mmpp/ tests/ scripts/
+
+# Lint code
+ruff check mmpp/ tests/ scripts/
+
+# Type checking
+mypy mmpp/
+
+# Build documentation
+cd docs && sphinx-build -b html . _build
+```
+
+## 🔬 Testing Guidelines
+
+### Test Categories
+
+- **Unit Tests**: Test individual functions/methods
+- **Integration Tests**: Test component interactions
+- **Performance Tests**: Verify performance requirements
+
+### Writing Tests
+
+```python
+import pytest
+from mmpp import MMPP
+
+def test_feature():
+    """Test description."""
+    # Arrange
+    data = setup_test_data()
+    
+    # Act
+    result = feature_under_test(data)
+    
+    # Assert
+    assert result.is_valid()
+```
+
+## 📚 Documentation
+
+### Building Documentation
+
+```bash
+cd docs
+pip install -r requirements.txt
+sphinx-build -b html . _build
+```
+
+### Documentation Structure
+
+- **tutorials/**: Step-by-step guides
+- **api/**: Auto-generated API documentation
+- **development/**: Development documentation
+
+## 🎯 Areas for Contribution
+
+We especially welcome contributions in these areas:
+
+- **Performance Optimization**: Improving computational efficiency
+- **Visualization**: New plotting features and improvements
+- **Testing**: Expanding test coverage
+- **Documentation**: Examples, tutorials, and API docs
+- **Bug Fixes**: Resolving issues and edge cases
+
+## 🤝 Community Guidelines
+
+- Be respectful and inclusive
+- Provide constructive feedback
+- Help newcomers get started
+- Follow the code of conduct
+
+## 📞 Getting Help
+
+- **Issues**: [GitHub Issues](https://github.com/MateuszZelent/mmpp/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/MateuszZelent/mmpp/discussions)
+- **Email**: mateusz.zelent@amu.edu.pl
+
+## 🏷️ Release Process
+
+For maintainers:
+
+1. Update version in `pyproject.toml`
+2. Update `RELEASE_NOTES.md`
+3. Create release tag
+4. Build and publish to PyPI
+
+---
+
+Thank you for contributing to MMPP! 🧲

mmpp-0.5.3/DEVELOPMENT.md

@@ -0,0 +1,167 @@
+# mmpp Development Guide
+
+## Setup Instructions
+
+### Prerequisites
+- Python 3.9 or higher
+- Git
+- Just (command runner) - install with: `cargo install just` or `pip install just-install`
+
+### Quick Start
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/mateuszzelent/mmpp.git
+   cd mmpp
+   ```
+
+2. **Setup development environment**
+   ```bash
+   just dev-setup
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. **Test the setup**
+   ```bash
+   python test_setup.py
+   ```
+
+## Development Workflow
+
+### Available Just Commands
+
+- `just build` - Build the package
+- `just install-local` - Install package locally for testing
+- `just test` - Run tests
+- `just lint` - Check code quality
+- `just format` - Format code with ruff
+- `just clean` - Clean build artifacts
+- `just prepare-release` - Prepare package for release
+- `just release` - Release to PyPI
+- `just release-test` - Release to TestPyPI for testing
+
+### Building and Testing Locally
+
+```bash
+# Format code
+just format
+
+# Run linting
+just lint
+
+# Run tests
+just test
+
+# Build package
+just build
+
+# Install locally
+just install-local
+
+# Test installation
+python -c "import mmpp; print('Success!')"
+```
+
+### Release Process
+
+1. **Prepare for release**
+   ```bash
+   just prepare-release
+   ```
+
+2. **Test on TestPyPI first**
+   ```bash
+   just release-test
+   ```
+
+3. **Create a git tag and push**
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+
+4. **GitHub Actions will automatically release to PyPI**
+
+## GitHub Actions
+
+### Automatic Releases
+
+1. **Set up PyPI tokens**:
+   - Go to PyPI.org and create an API token
+   - Add it to GitHub repository secrets as `PYPI_API_TOKEN`
+   - For TestPyPI, add `TEST_PYPI_API_TOKEN`
+
+2. **Create a release**:
+   - Push a tag starting with 'v' (e.g., v0.1.0)
+   - GitHub Actions will automatically build and release
+
+3. **Manual release**:
+   - Go to GitHub Actions tab
+   - Run "Release to PyPI" workflow manually
+   - Choose TestPyPI option for testing
+
+### CI/CD Pipeline
+
+- **Continuous Integration**: Runs on every push and PR
+- **Multi-platform testing**: Ubuntu, Windows, macOS
+- **Multi-Python testing**: Python 3.9, 3.10, 3.11
+- **Code quality checks**: ruff, mypy
+- **Test coverage**: pytest with coverage reporting
+
+## Package Structure
+
+```
+mmpp/
+├── mmpp/                   # Main package
+│   ├── __init__.py        # Package initialization
+│   ├── core.py            # Core functionality (from main.py)
+│   ├── plotting.py        # Plotting utilities
+│   ├── simulation.py      # Simulation management (from swapper.py)
+│   ├── cli.py             # Command line interface
+│   ├── paper.mplstyle     # Matplotlib style
+│   └── fonts/             # Custom fonts
+├── tests/                 # Test suite
+├── .github/               # GitHub workflows
+├── pyproject.toml         # Modern Python package configuration
+├── setup.py              # Legacy setup (for compatibility)
+├── justfile              # Task automation
+├── README.md             # Package documentation
+├── LICENSE               # MIT license
+└── MANIFEST.in           # Package data inclusion
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Import errors**: Make sure all dependencies are installed
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+2. **Font issues**: The package includes custom fonts, but system fonts will be used as fallback
+
+3. **Missing dependencies**: Use extras for optional features:
+   ```bash
+   pip install mmpp[plotting,interactive]
+   ```
+
+### Version Management
+
+```bash
+# Bump patch version (0.1.0 -> 0.1.1)
+just bump-patch
+
+# Bump minor version (0.1.0 -> 0.2.0)
+just bump-minor
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linting
+5. Submit a pull request
+
+All contributions are welcome!