Skip to main content

A plain language Python wrapper for NEC

Project description

NECBOL PyPI Downloads

NECBOL is a Python library that provides a geometry-first interface for building antenna models using the NEC (Numerical Electromagnetics Code) engine.

Features

  • Component-based antenna construction: Easily create antennas using predefined components.
  • Flexible length units: Specify antenna dimensions in mm, m, cm, ft or in as needed.
  • Automatic wire joining: Automatically connects wire ends to other wires, simplifying model creation.
  • Flexible connector placement: Add connectors between specific points on different objects.
  • Configurable simulation parameters: Set frequency, ground type, and pattern observation points.
  • Current component library: Helix, circular arc/loop, rectangular loop, straight wire, straight connector, thin sheet
  • Easy to place: feedpoint, series RLC load(s), prarallel RLC load(s) specified in ohms, uH and pF
  • Easy to define meshed grids which can also be joined edge to edge to create box structures (see the car model)
  • Dielectric sheet model: currently experimental, not validated, built in to a flat sheet geometry component
  • Optimiser: Optimise VSWR and / or Gain in a specified direction
  • Extensible design: It's written in Python, so you can use the core and add your own code
  • Example files: Include Simple dipole, Hentenna with reflector with example parameter sweep, Circular version of Skeleton Slot Cube with Optimiser code
  • Wire Frame Visualiser shows wire thickness to help understand wire proximity
  • Option to specify component colouring in wireframe view helps visualise connections

Capture

🛠 Installation

Install using pip: open a command window and type

pip install necbol

User Guide

Documentation is work in progress. In the meantime:

  • For a quick and basic overview, see the file "example_dipole_with_detailed_comments.py" in the examples folder for a minimal explanation of how to use this framework.

  • There are several more example files in the examples folder intended to highlight different aspects of necbol and different ways of doing similar things. You can copy these examples and modify to see how they work, or start your own from scratch.

  • Automated user documentation is here. You can see an outline of all code here.

  • You can browse the source files in the necbol folder (however note that they may be ahead of the release on pip).

  • Please look at the change history, especally if you've used previous versions

  • Note that the TO_DO list has been deleted and captured in GitHub issues

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

necbol-3.2.2.tar.gz (355.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

necbol-3.2.2-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file necbol-3.2.2.tar.gz.

File metadata

  • Download URL: necbol-3.2.2.tar.gz
  • Upload date:
  • Size: 355.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for necbol-3.2.2.tar.gz
Algorithm Hash digest
SHA256 a1c964aa573850f75dcaf5edda04530f1fa8241b500bef553a5b568a2d0495fc
MD5 17f45097fb2a222f28db1d7a679eb551
BLAKE2b-256 44b059b82465f1ed05772a8b17f1679dc43cc86e3eaa4818b182405d3b40cf4c

See more details on using hashes here.

File details

Details for the file necbol-3.2.2-py3-none-any.whl.

File metadata

  • Download URL: necbol-3.2.2-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for necbol-3.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c0d008213ca41ab856df45b9c2b487d05becbebfdae18ff263d139333322bfa0
MD5 bb001b892f38bd51eb3c438b2543cd91
BLAKE2b-256 6e0054173d13a7dfca5eeaeff3a0ed52d395157153f63adcf0f6e50faefee3c7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page