examples/README.md

52 lines
1.6 KiB
Markdown

# 4nec2-web Example Antennas
A curated collection of antenna models for the [4nec2-web](https://4nec2-web.supported.systems) antenna modeling application.
## Categories
| Folder | Description | Count |
|--------|-------------|-------|
| `simple/` | Basic antenna designs for beginners | 4 |
| `vertical/` | Ground-plane and vertical designs | 4 |
| `beam/` | Directional antennas with gain | 4 |
| `loop/` | Quad loops and delta configurations | 2 |
| `wideband/` | Broadband and specialized designs | 2 |
## File Format
All files use the standard NEC2 input format with extended metadata in comment cards:
```nec
CM Half-Wave Dipole for 20m Band
CM Simple horizontal dipole in free space
CM @category: simple
CM @band: 20m
CM @author: 4nec2-web
CM @tags: dipole, beginner, hf
CE
```
### Metadata Fields
| Field | Description |
|-------|-------------|
| `@category` | Folder/grouping (simple, vertical, beam, loop, wideband) |
| `@band` | Primary operating band (20m, 2m, HF, VHF, etc.) |
| `@author` | Design attribution |
| `@tags` | Comma-separated search keywords |
## Adding Your Own Collection
4nec2-web supports adding custom antenna collections from any git repository. Simply add your repo URL in the app's collection manager.
## Contributing
Pull requests welcome! Please ensure your .nec files:
1. Include descriptive CM comment lines
2. Add `@category`, `@band`, and `@tags` metadata
3. Are tested in the 4nec2-web simulator
## License
These example files are provided for educational purposes. Many designs are based on classic antenna configurations in the public domain.