Getting started#

PolSARtools package generates derived SAR parameters (viz. polarimetric descriptors, vegetation indices, polarimetric decomposition parameters) from different SAR sensors or input polarimetric matrix (C3, T3, C2, T2).

💾 Installation#

  1. Install `gdal` Package

conda install gdal -c conda-forge

  1. Install `polsartools` Package

You can install it using pip:

pip install polsartools

If you encounter an error like “function not found” or need the latest version, you can install the updated version directly from GitHub:

pip install git+https://github.com/Narayana-Rao/polsartools.git#egg=polsartools

Example Usage#

Sample use cases and notebooks are provided at polsartools-notebooks repo. Detailed documentation is available at polsartools.readthedocs.io.

🤝 Contributing#

We welcome contributions! Whether it’s fixing bugs, adding new features, or improving documentation, your help is greatly appreciated.

How to Contribute#

  1. Fork the repository - Fork this repository to your GitHub account.

  2. Clone your fork - Clone the repository to your local machine:

    git clone https://github.com/Narayana-Rao/polsartools.git

  3. Create a branch - Create a new branch for your changes:

    git checkout -b feature-branch

  4. Make changes - Implement your changes or additions.

  5. Test your changes - Run the tests to ensure that your changes don’t break anything.

  6. Commit and push - Commit your changes and push them to your fork:

    git commit -am "Description of changes"
git push origin feature-branch

  7. Create a Pull Request - Open a pull request to the main repository with a clear description of the changes.

🐞 Bug Reporting#

If you encounter a bug or issue, please follow these steps to report it:

  1. Check the existing issues: Before submitting a new bug report, check if the issue has already been reported in the Issues section.

  2. Submit a bug report: If the issue hasn’t been reported, please open a new issue and include the following information:

    • A clear description of the problem.

    • Steps to reproduce the issue.

    • Expected vs actual behavior.

    • Any error messages or stack traces.

    • Relevant code snippets or files if possible.

    • Version of polsartools and Python you’re using.

Click here to report a bug

💡 Feature Requests#

We’re always open to suggestions for new features or improvements!

  1. Check existing feature requests: Please make sure the feature request hasn’t already been made in the Issues section.

  2. Submit a feature request: If it hasn’t been requested already, please open a new issue with the following information:

    • A clear description of the feature.

    • Why you think this feature would be beneficial.

    • Any specific use cases or examples.

Click here to request a feature

📚 Cite Us!#

If you use PolSARtools in your research or projects, we’d really appreciate a citation! 🛰️✨

Please cite our work as:

Bhogapurapu, N., Dey, S., Mandal, D., Bhattacharya, A., and Rao, Y.S. (2021). PolSAR tools: A QGIS plugin for generating SAR descriptors. Journal of Open Source Software, 6(60), p.2970. 🔗 https://doi.org/10.21105/joss.02970

BibTeX 📄#

@article{bhogapurapu2021polsar,
  title={PolSAR tools: A QGIS plugin for generating SAR descriptors},
  author={Bhogapurapu, Narayanarao and Dey, Subhadip and Mandal, Dipankar and Bhattacharya, Avik and Rao, YS},
  journal={Journal of Open Source Software},
  volume={6},
  number={60},
  pages={2970},
  year={2021},
  doi={10.21105/joss.02970}
}

🙏 Your support means a lot and helps us keep improving PolSARtools!