solunatus 0.4.0

High-precision astronomical calculation library and CLI for sun/moon positions, rise/set times, and lunar phases
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# Solunatus Documentation

Welcome to the Solunatus documentation. This folder contains comprehensive guides for both users and developers.

## For Users

### Getting Started
- **[Installation](installation/README.md)** - How to install and set up Solunatus
- **[Quick Start](installation/quick-start.md)** - Get running in 5 minutes

### Features
- **[Astronomical Calculations](features/README.md)** - Overview of supported calculations
- **[CLI Reference](features/cli-reference.md)** - Complete command-line options guide
- **[Interactive Mode](features/interactive-mode.md)** - Guide to the TUI watch mode
- **[City Database](features/city-database.md)** - Using the built-in city database
- **[JSON Output](features/json-output.md)** - Machine-readable output format
- **[Calendar Generation](features/calendar.md)** - Generating astronomical calendars
- **[AI Insights](features/ai-insights.md)** - Using Ollama for narrative summaries

### Troubleshooting
- **[Troubleshooting Guide](installation/troubleshooting.md)** - Common issues and solutions

## For Developers

### Getting Started
- **[Development Setup](development/setup.md)** - Building from source
- **[Architecture Overview](development/architecture.md)** - Project structure and module organization
- **[User Feedback](../CONTRIBUTING.md)** - How to report bugs and request features

### Deep Dives
- **[Astronomical Accuracy](development/accuracy.md)** - Testing methodology and accuracy verification
- **[Lunar Calculations](development/lunar-calculations.md)** - Deep dive into lunar algorithms
- **[Solar Calculations](development/solar-calculations.md)** - Deep dive into solar algorithms
- **[Performance Optimization](optimization/performance.md)** - Optimization techniques and benchmarks

### Reference
- **[API Documentation](https://docs.rs/solunatus)** - Auto-generated API docs on docs.rs
- **[Changelog](../CHANGELOG.md)** - Version history and changes

## Documentation Index

```
docs/
├── README.md (this file)
├── development/
│   ├── setup.md
│   ├── architecture.md
│   ├── accuracy.md
│   ├── lunar-calculations.md
│   └── solar-calculations.md
├── features/
│   ├── README.md
│   ├── cli-reference.md
│   ├── interactive-mode.md
│   ├── city-database.md
│   ├── json-output.md
│   ├── calendar.md
│   └── ai-insights.md
├── installation/
│   ├── README.md
│   ├── quick-start.md
│   └── troubleshooting.md
└── optimization/
    └── performance.md
```

## Quick Navigation

**I want to...**

- [Install Solunatus](installation/README.md) → Installation guide
- [Use the CLI](features/cli-reference.md) → Command-line reference
- [Get programmatic output](features/json-output.md) → JSON output guide
- [Build from source](development/setup.md) → Development setup
- [Understand how it works](development/architecture.md) → Architecture overview
- [Verify accuracy](development/accuracy.md) → Accuracy testing
- [Report a bug or request a feature](https://github.com/FunKite/solunatus/issues) → GitHub issues

## Key Resources

- **[Main README](../README.md)** - Project overview and features
- **[License](../LICENSE)** - MIT License
- **[Code of Conduct](../CODE_OF_CONDUCT.md)** - Community guidelines
- **[GitHub Repository](https://github.com/FunKite/solunatus)** - Source code
- **[Crates.io](https://crates.io/crates/solunatus)** - Rust package registry

## Documentation Feedback

Found a typo or confusing section? Want to suggest documentation improvements? Please open a [GitHub Issue](https://github.com/FunKite/solunatus/issues) to let us know!