DOC: Restructure Py-ART Docs with 2.0 Release #1778
Description
It is time for a documentation refresh! 📰
We should follow this structure:
Getting Started
- Overview: Why Py-ART? (overview.md) (DOC: Add new why py-art guide #1786)
- What a common data model enables
- xradar vs. legacy radar data structure
- Goals and aspirations
- Installation (installation.md)
- Required dependencies
- Optional dependencies
- Minimum dependency versions
- Instructions
- Testing
- Quick overview (quick-tutorial.md)
- Load in some radar data
- Selecting (by azimuth, gate, column)
- Computation (example QPE)
- Masks and gatefilters
- Plotting (PPI, RHI, etc)
- Read and write cfradial1/cfradial2
- Tutorials and Videos (resources.md)
- Tutorials and Short Courses (ams/erad)
- Videos (ie MSCAR)
User Guide
Data Model
- Terminology
- Datastructures
- xradar object
- radar object
- DataTree
- Hierarchal Data
- Working with sweeps
- Operating on all sweeps
- Subsetting a single sweep
- Parallel computing with dask
- Example applying this to the radar object
- Best practices
Core operations
- Indexing data + selecting
- ray, gate, azimuth, CVP, QVP
- Combining fields/radars
- Merging multiple radars
- Gridding
- Techniques, general workflow, suggestions for scaling
- QPE
- Z(R) / Z(S)
- R(A)
- Data Quality
- Dealiasing velocity
- KDP correction
- Attenuation correction
- IO
- Reading and writing radar data
- Interoperability
- Working with xradar
- Working with wradlib
- Py-ART related projects
- Visualization
- PPI
- RHI
- CAPPI
- CFAD
- Interactive
Get Help
- Getting help flowchart similar to xarray
- How do I...
- The Openradar Forum
Developer's Guide
- Contributing to Py-ART
- Overview, where to start, git, bug reports, features, environments, git
- Development roadmap
- What's New (release notes)
- Developer's meeting
Release Notes
- Running release notes