InhomCorr

Installation for developers

1. Clone the repo
2. Create/select a python environment
3. Open terminal in the "InhomCorr" main folder
4. Install "InhomCorr" in editable mode with linting and testing: pip install -e ".[lint,test]"
5. Setup Pre-Commit Hook: pre-commit install

Recommended IDE and Extensions

We recommend to use Microsoft Visual Studio Code with the following extensions:

• Python (Microsoft)
• Pylance (Microsoft)
• isort (Microsoft)
• Python Indent (Kevin Rose)
• Python Type Hint (njqdev)
• Editorconfig for VS Code (EditorConfig)
• Mypy (Martan Gover)
• autoDocstring (Nils Werner)
• markdownlint (David Anson)
• Even Better TOML (tamasfe)

Further extensions that might be useful:

• IntelliCode (Microsoft)
• Remote - SHH (Microsoft)
• GitHub Copilot (GitHub - fee-based )

Note that this project uses a pyproject.toml instead of setup.py file