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
  • 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
  • More coming soon: See next steps/future plans
  • Extensible design: It's written in Python, so you can use the core and add your own code
  • Example files: Simple dipole, Hentenna with reflector with example parameter sweep, Circular version of Skeleton Slot Cube with Optimiser code

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.1.2.tar.gz (354.0 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.1.2-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for necbol-3.1.2.tar.gz
Algorithm Hash digest
SHA256 5a4ec349a7fa19de58ed0bbf6956351f34bad765a1f5f534cf2bfc3ed0861fbe
MD5 a17acf0986ae9d0b84fb259a7b1e8463
BLAKE2b-256 c8f8c400f34a4ad1fc900c3ba98be110c932651a10eaf046092a2f69ec80e32f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: necbol-3.1.2-py3-none-any.whl
  • Upload date:
  • Size: 25.7 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.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 72542eb8982852d4a1a0409ff704e60bed1eec0e76f674e8638b2834049e16bc
MD5 96d5db5bf41395a0688d2b219ea65a6e
BLAKE2b-256 8e6f98a56fa15c41e6a0803d704d0726034e63071ed88a6c36ec6ad3e4795d20

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