Skip to main content

A plain language Python wrapper for NEC

Project description

NECBOL

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

⚠️ VERSION V2.0.0 has some limited function name and module name changes

If you have been using V1.0.0 with your own python files, you'll need to change the import statements and the name of the wire viewer function. See the file CHANGES from V1.0.0.md for details.

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 wires that intersect, 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
  • 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

⚠️ Note: NECBOL is a very new project, and my first released using pip. Code comments are work in progress, and I have yet to decide how to add a user guide.

🛠 Installation

Install using pip: open a command window and type

pip install necbol

Copies of the files installed by pip are in the folders on this repository - see the Python files example_ ... and modify to suit your needs. Tip: Look inside necbol/components.py to see which antenna components and modification methods are currently available.

User Guide

See the file example_minimal_example_dipole_with_detailed_comments.py for a minimal explanation of how to use this framework. Browse the other examples as needed, and see the comments in the necbol/*.py files which are currently being written.

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-2.0.1.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

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

necbol-2.0.1-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for necbol-2.0.1.tar.gz
Algorithm Hash digest
SHA256 2543b1655c27c851418b68c692e896d167af0caf8100d179adb3631bf09dbb35
MD5 6565b8dd06755f584efd648ffbd12374
BLAKE2b-256 18e7d1f11cda04e36a80966fe81c59aefe5c89077b48a4f93c38ec69bf09c6c8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for necbol-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fff7c955a39aa478352d38745b3a02f60883b926d536cf42026e7714574fe15c
MD5 4c28396b1d354a2e122b6c56c8704938
BLAKE2b-256 9eea5cf384d78104272f26c407dd0a2d26031d83e7859d38c59d36921844a4be

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