climdata v0.5.1
🎯 Focus: Documentation, FAIR Compliance & Data Licensing
📚 Documentation Improvements
- New MSWX Dataset Guide (
docs/MSWX_guide.md) with comprehensive setup instructions - Zenodo & DOI Archival Guide for persistent identifiers and research reproducibility
- Enhanced Google Drive API setup with security best practices
- Clarified data licensing terms (CC BY-NC 4.0 for MSWX)
⚖️ Licensing & Compliance
- Added explicit CC BY-NC 4.0 license information for MSWX in configuration
- Access requirements clearly documented at https://www.gloh2o.org/mswx/
- Commercial use restrictions prominently displayed in README and dataset guide
- Usage restrictions added to
climdata/conf/mappings/parameters.yaml
🔗 FAIR Principles Implementation
- Created CITATION.cff for standardized software citation (GitHub "Cite this repository" button)
- Added codemeta.json for machine-readable metadata (CodeMeta standard)
- Improved discoverability via structured metadata and keywords
- Enhanced API documentation and dataset descriptions
🌐 Website Updates
- New Datasets section in documentation navigation with MSWX guide
- New Documentation section with Zenodo & DOI archival guide
- Added MSWX example notebook to Examples gallery
- Updated navigation structure for better user experience
🔐 Security & Best Practices
- Added
.gitignorerecommendations for credential files - File permission recommendations for service account keys
- Secure storage guidelines for Google Drive API credentials
📋 Configuration Enhancements
- MSWX metadata now includes:
license: CC BY-NC 4.0 (Non-Commercial Use Only)access_url: Direct link to data access request portaldescription: Dataset overview and citation informationusage_restrictions: Clear commercial prohibition statement
🐛 Bug Fixes
- Improved error handling for Google Drive API authentication failures
- Fixed path handling for service account JSON files
📖 Full Documentation
- Complete Google Drive API setup (6-step process)
- MSWX access request workflow
- Data citation guidelines for publications
- DOI badge and permanent identifier setup
✨ Highlights
✅ Non-commercial users can now easily access MSWX with clear, compliant documentation
✅ Researchers can cite climdata properly with BibTeX, APA, and other formats
✅ Software registries can discover climdata via codemeta.json and CITATION.cff
✅ Zenodo integration enables persistent DOIs for every release
✅ FAIRness significantly improved (Findable, Accessible, Interoperable, Reusable)
🔗 Resources
- Documentation: https://Kaushikreddym.github.io/climdata
- MSWX Dataset: https://www.gloh2o.org/mswx/
- GitHub Repository: https://github.com/Kaushikreddym/climdata
- Zenodo Guide: See docs/zenodo_guide.md
📝 Citation
@software{muduchuru2024climdata,
title={climdata: Automated Climate Data Extraction and Processing},
author={Muduchuru, Kaushik},
year={2024},
version={0.5.1},
url={https://github.com/Kaushikreddym/climdata}
}