Roadmap for Dendro Module

[MartinHinz]

Overview

This issue tracks the development milestones for implementing a dedicated Dendrochronology (Dendro) module in the XRONOS database. The module will handle the storage, import, validation, and presentation of dendrochronological data while ensuring integration with existing database structures and improving user accessibility.

The following tasks outline the steps necessary to implement this module.

---

Development Milestones

Database and Model Design

• Verify the current Dendro model to ensure compatibility with existing data structures.

Implement Data Import

• Create a rake task to process dendro data imports
• Develop a CSV importer that maps dendrochronological data to Dendro records
• Validate input data (e.g., ensure earliest_year < latest_year, numerical values are correct)
• Implement error handling for faulty imports
• Prevent duplicate entries unless explicitly allowed

Paper Trail

• Enable version control for dendro data to track modifications

Curation

• Add issue tracking to dendro dates to flag potential inconsistencies or missing metadata
• Implement issue handling in the curation backend to facilitate review and resolution

Develop API Endpoints

• Define and implement RESTful API endpoints for retrieval of dendro data.
• Ensure API supports filtering, and efficient querying
• Implement data export functionality (CSV, JSON)

Create Views for Data Presentation and Modification

• Fix the "Edit Series" modal, which is not working correctly #383
• Check for completeness of data to be entered
• Check for completeness of data to be shown
• Implement filters and search functionality: #385
  • The filter by date range should be general and placed outside the radiocarbon accordion
  • Add specific dendro filters to refine searches
  • Hide the radiocarbon accordion if only dendro data is selected, and vice versa
• Develop visualization components (charts) to better represent dendro data

Implement Validation and Testing

• Write model validations:
  • Ensure earliest_year ≤ latest_year
  • Ensure the presence of tree_species and dating_method
• Create tests for:
  • Model validation
  • API endpoints
  • Data import functionality
  • Frontend UI rendering and filtering

Deployment and Documentation

• Prepare database seed files with sample dendrochronological data
• Deploy changes to a staging environment for testing
• Write documentation:
  • API usage guide
  • Data format specifications
  • Import/export instructions

General Improvements

• Review and improve authentication and authorization to ensure proper data access control
• Optimize queries with indexing for faster retrieval
• Import initial datasets

---

Completion Criteria

This issue will be considered resolved when:

• The new dendro module is fully functional and integrated into the XRONOS database.
• Data import, validation, and presentation mechanisms are in place.
• API endpoints are operational and documented.
• User access and curation workflows are established.
• Performance optimizations and security checks are completed.

Related Issues:

• List to be filled

Target Milestone:

• Version 1.2?