Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
de0218b
Add files via upload
admahood Jul 2, 2025
371b495
Update README.md
admahood Jul 2, 2025
e42e69d
Update README.md
admahood Jul 2, 2025
c45a99b
Update README.md
admahood Jul 2, 2025
f74d8ea
Update README.md
admahood Jul 2, 2025
a2fbd48
Update README.md
admahood Jul 2, 2025
d437b60
Update README.md
admahood Jul 2, 2025
274fc65
Update README.md
admahood Jul 2, 2025
c4184c7
Update README.md
admahood Jul 2, 2025
6dbd692
Update README.md
admahood Jul 2, 2025
84834d7
Update README.md
admahood Jul 2, 2025
d7de501
Update README.md
admahood Jul 2, 2025
71a60c8
Update README.md
admahood Jul 2, 2025
b9dbebf
Update README.md
admahood Jul 2, 2025
f0e46da
Update README.md
admahood Jul 2, 2025
4a25ad1
Update README.md
admahood Jul 2, 2025
23babeb
Update README.md
admahood Jul 2, 2025
a69df93
Update README.md
admahood Jul 2, 2025
3e54465
Update README.md
admahood Jul 2, 2025
79a6d7f
Update README.md
admahood Jul 2, 2025
62d1a47
Update README.md
admahood Jul 2, 2025
8d58a88
Update README.md
admahood Jul 2, 2025
48c9e56
Update README.md
admahood Jul 2, 2025
c7486fa
Update README.md
admahood Jul 2, 2025
df83018
Update README.md
admahood Jul 2, 2025
6b28e1e
Add EarthAccess integration
Ktmanley Jul 28, 2025
98cc591
Add files via upload
ktmanley23 Aug 6, 2025
8290366
Updated workflow documentation
natshoff Oct 20, 2025
b718b7c
Rename development_workflow.md to DEVELOPMENT.md
natshoff Oct 20, 2025
eb19909
Merge pull request #100 from earthlab/NH-dev
natshoff Oct 20, 2025
5f7a45f
Updated contributing and dvelopment to be more silo'd
natshoff Oct 22, 2025
91640e6
Update DEVELOPMENT.md
natshoff Oct 22, 2025
65e924f
Update DEVELOPMENT.md
natshoff Oct 22, 2025
cf342d4
Added version to changelog
natshoff Oct 22, 2025
67ec082
Update README.md
admahood Oct 23, 2025
97f5f98
added citation and data sharing agreement
natshoff Dec 2, 2025
59bea48
Merge pull request #111 from earthlab/NH-dev
natshoff Dec 2, 2025
36d50f8
data sharing agreement update
natshoff Dec 3, 2025
5356bc6
Update README.md
admahood Dec 3, 2025
d2b4fb5
Update README.md
admahood Dec 3, 2025
a000bae
Update README.md
admahood Dec 3, 2025
2ee0fe4
Update README.md
admahood Dec 3, 2025
1bd433f
Update README.md
admahood Dec 4, 2025
e418016
Update README.md
admahood Dec 4, 2025
518481d
Update README.md
admahood Dec 4, 2025
1a3ad4b
Update README.md
admahood Dec 4, 2025
398e4c9
Update README.md
admahood Dec 4, 2025
70d503c
Update environment.yml
admahood Dec 4, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug Report
about: Report a bug or unexpected behavior in firedpy
title: '[BUG] '
labels: ['bug', 'needs-triage']
assignees: ''
---

## Bug Description
A clear description of what the bug is.

## To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Run command '...'
3. See error

## Expected Behavior
A clear description of what you expected to happen.

## Environment Details
- **OS**: [e.g. Windows 10, macOS 12.0, Ubuntu 20.04]
- **Python version**: [e.g. 3.8.5]
- **firedpy version**: [e.g. 0.1.0]
- **Region/Country**: [e.g. Australia, California, Global]

## Data Processing Details
- **Date range**: [e.g. 2020-01-01 to 2020-12-31]
- **Spatial extent**: [e.g. coordinates or region name]
- **Processing parameters**: [e.g. specific thresholds, filters used]
- **Input data files**: [if applicable, describe the data files used]

## Error Information
```
Paste any error messages or logs here
```

## Additional Context
Add any other context about the problem here.

## Screenshots/Outputs
If applicable, add screenshots or example outputs to help explain your problem.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true # set to false if you don't want people creating blank issues - I think they should have the option though
contact_links:
#- name: GitHub Discussions # can uncomment if we want to use this
# url: https://github.com/your-username/firedpy/discussions
# about: Please ask questions and discuss ideas here before opening an issue.
- name: Documentation
url: https://firedpy.readthedocs.io/
about: Check the documentation for usage guides and API reference.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Feature Request
about: Suggest an idea for firedpy
title: '[FEATURE] '
labels: ['enhancement', 'needs-triage']
assignees: ''
---

## Feature Description
A clear and concise description of the feature you'd like to see implemented.

## Problem Statement
What problem does this feature solve? What is the current limitation?

## Proposed Solution (optional)
Describe your proposed solution.

## Use Case (optional)
Describe the specific use case or scenario where this feature would be valuable:
- **Research area**: [e.g. fire ecology, climate change, land management]
- **User type**: [e.g. researcher, student, practitioner]
- **Data type**: [e.g. satellite imagery, ground observations, model outputs]

## Scientific Context (optional)
- **Relevant literature**: [if applicable, cite papers or methods]
- **Data requirements**: [what data sources would be needed]
- **Validation approach**: [how would this feature be validated]

## Implementation Ideas (optional)
If you have ideas about how this could be implemented:
- **Dependencies**: [any new packages or libraries needed]
- **Performance considerations**: [computational requirements]
- **Integration points**: [how it fits with existing functionality]

## Additional Context
Add any other context, screenshots, or examples about the feature request here.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Question
about: Ask a question about firedpy usage, methodology, or data interpretation
title: '[QUESTION] '
labels: ['question', 'needs-triage']
assignees: ''
---

## Question
A clear and concise description of your question.

## Context
Provide context about your research or use case:
- **Research objective**: [what are you trying to achieve?]
- **Data source**: [what fire data are you working with?]
- **Geographic region**: [where is your study area?]
- **Temporal scope**: [what time period are you analyzing?]

## What You've Tried
Describe what you've already attempted:
- **Code/commands used**: [paste relevant code snippets]
- **Documentation consulted**: [what have you already read?]
- **Previous attempts**: [what approaches have you tried?]

## Specific Question
What specific aspect do you need help with?
- [ ] Installation/setup
- [ ] Data processing workflow
- [ ] Parameter selection
- [ ] Results interpretation
- [ ] Performance optimization
- [ ] Integration with other tools
- [ ] Other: [please specify]

## Expected Outcome
What would a successful answer look like for you?

## Additional Information
- **firedpy version**: [if applicable]
- **Python version**: [if relevant]
- **Operating system**: [if relevant]
- **Sample data**: [if you can share anonymized examples]
8 changes: 8 additions & 0 deletions .github/pull_request_template_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false # I do think we should require PR templates for everything but we can alter this if people feel differently
contact_links:
#- name: GitHub Discussions
# url: https://github.com/your-username/firedpy/discussions
# about: Please ask questions and discuss ideas here before opening a PR.
- name: Documentation
url: https://firedpy.readthedocs.io/
about: Check the documentation for usage guides and API reference.
83 changes: 83 additions & 0 deletions .github/pull_request_template_major.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
name: Major Change/Release
about: Use this template for major features, breaking changes, or new releases
title: '[MAJOR] '
---

## Description
Detailed description of the major changes made in this pull request.

## Type of Change
- [ ] Major new feature
- [ ] Breaking change
- [ ] New release version
- [ ] Significant performance improvement

## Version Impact
- **New version required**: [ ] Yes [ ] No
- **Version number**: [e.g. 1.0.0, 0.2.0]
- **Update README**: [ ] Yes [ ] No

## Detailed Changes
### New Features
- [ ] Added new functionality: [describe]
- [ ] New data sources supported: [list]
- [ ] New processing methods: [describe]
- [ ] New output formats: [list]

### Breaking Changes
- [ ] API changes: [describe]
- [ ] Parameter changes: [describe]
- [ ] Output format changes: [describe]
- [ ] Dependencies updated: [list]

### Performance Impact
- **Memory usage**: [describe changes]
- **Processing speed**: [describe changes]
- **Storage requirements**: [describe changes]

## Scientific Validation
- **Test datasets used**: [list datasets and sources]
- **Validation methods**: [describe how changes were validated]
- **Benchmark comparisons**: [describe any benchmark testing]
- **Peer review**: [ ] Internal [ ] External [ ] Published validation

## Documentation Updates (talk through as a group)
- [ ] README updated
- [ ] Tutorials updated
- [ ] Changelog updated
- [ ] Release notes prepared

## Testing Coverage (talk through as a group)
- [ ] Unit tests added/updated
- [ ] Performance tests added/updated
- [ ] Real data validation completed
- [ ] Edge case testing completed
- [ ] Backward compatibility tested

## Data Processing Impact
### Input/Output Changes
- **Input requirements**: [any changes to input data requirements]
- **Output format**: [any changes to output structure]
- **File formats**: [any new or changed file formats]
- **Metadata**: [any changes to metadata handling]

### Processing Pipeline
- **Algorithm changes**: [describe any algorithm modifications]
- **Parameter defaults**: [any changes to default parameters]
- **Quality control**: [any changes to QC procedures]
- **Error handling**: [any changes to error handling]

## Related Issues
Closes #[issue number]
Related to #[issue number]

## Additional Notes
Any additional information that reviewers should know about this major change.

## Checklist
- [ ] All tests pass
- [ ] Documentation updated
- [ ] Performance impact assessed
- [ ] Version number updated
- [ ] Changelog updated
36 changes: 36 additions & 0 deletions .github/pull_request_template_minor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Minor Fix/Update
about: Use this template for minor bug fixes, small updates, or documentation changes
title: '[MINOR] '
---

## Description
Brief description of the minor changes made in this pull request.

## Type of Change
- [ ] Minor bug fix
- [ ] Small feature addition
- [ ] Documentation update
- [ ] Code cleanup
- [ ] Minor performance improvement

## Changes Made
- [ ] Fixed bug: [brief description]
- [ ] Added small feature: [brief description]
- [ ] Updated documentation: [what was updated]
- [ ] Code cleanup: [what was cleaned up]

## Testing
- [ ] Bug fix tested
- [ ] No new issues introduced
- [ ] Existing functionality preserved

## Related Issues
Closes #[issue number]

## Checklist
- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Tests pass
- [ ] No breaking changes
- [ ] Documentation updated (if needed)
90 changes: 90 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Changelog

All notable changes to FIREDpy will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

---

## [2.0.0] - 2023

### Added
- Temporal range: Nov 2000 - July 2024
- Parameters
- CONUS
- Temporal: 5 days
- Spatial: 1 pixel
- GLOBAL
- Temporal: 5 days
- Sptail: 1 pixel

### Changed
- Changed spatial and temporal aggregtation to 5 days, 1 pixels for all countries
- Bug fixes
- Optimized edge case algorithm
- New MODIS v6.1
- Extended time series

---

## [1.0.0] - 2022

### Added
- Initial FIREDpy release
- Temporal range: 2001 - 2021
- Parameters
- CONUS
- Temporal: 11 days
- Spatial: 5 pixels
- GLOBAL
- Temporal: variable
- Sptail: variable
- Validations: CONUS burned area comparison using MTBS and NIFC perimeters

---

## Template for Future Releases

### [X.Y.Z] - YYYY-MM-DD

#### Added
- New features and capabilities
- New data sources or processing methods
- New output formats or analysis tools

#### Changed
- Improvements to existing functionality
- Performance optimizations
- API updates (backward compatible)

#### Removed
- Features that have been removed

#### Fixed
- Bug fixes and error corrections
- Performance improvements
- Documentation updates

---

## Versioning Guidelines

### MAJOR (X.0.0)
- Core algorithm improvements (e.g., Köppen optimization)
- Breaking changes to API or data formats
- Major architectural changes

### MINOR (X.Y.0)
- Individual improvements (e.g., cFRP integration, speed integration)
- New features that are backward compatible
- New data sources or processing methods

### PATCH (X.Y.Z)
- Bug fixes and small performance updates
- Documentation improvements
- Code refactoring without functional changes

---

*This changelog is maintained as part of the FIREDpy development workflow. See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines and [development_workflow.md](development_workflow.md) for versioning policies.*
Loading
Loading