Skip to main content

Python API for FEMAG

Project description

Introduction to Femagtools

logo

Build status

Femagtools is an Open-Source Python-API for FEMAG offering following features:

  • run Femag with a FSL script file anywhere: locally (single and multi-core), remote (ZMQ), HT Condor, Cloud (Amazon AWS, Google Cloud), Docker
  • read I7/ISA7, NC, BCH/BATCH, PLT, ERG files
  • read and write MCV files (magnetizing curves)
  • create a variety of plots
  • create FSL files from model and calculation templates and/or user specific FSL
  • create FSL files from DXF
  • create and analyze symmetrical windings
  • sizing and parameter identification
  • calculate machine characteristics by using analytic machine models
  • execute parameter studies and multi-objective optimization

The package can be used with Python 3.x on Linux, MacOS or Windows and is hosted on github: https://github.com/SEMAFORInformatik/femagtools/ where also many examples can be found in the examples directory. Contributions and feedback to this project are highly welcome.

The installation can be done in the usual ways with pip:

pip install 'femagtools[all]'

[all] pulls in all optional dependencies. Up-to-date information about optional dependencies can be found in the pyproject.toml file under [project.optional-dependencies].

For details see the documentation http://docs.semafor.ch/femagtools

Modules and Scripts

The package provides following modules:

  • mcv, tks, jhb, losscoeffs: handling magnetizing curves and iron losses
  • erg, bch: read ERG, BCH/BATCH files created by FEMAG
  • model, fsl: create machine and calculation models
  • femag: manage the FEMAG calculation
  • airgap: read airgap induction file created by a previous calculation
  • machine: analytical machine models
  • windings: create and analyze windings
  • grid: running parameter variations
  • opt: running multi objective optimizations
  • plot: creating a variety of plots
  • dxfsl: create FSL from DXF
  • isa7, nc: read ISA7/I7, NC (NetCDF) files
  • windings: create and analyze windings
  • forcedens: read PLT files
  • amazon, google, condor, multiproc: engines for the calculation in Cloud and HTCondor environments or locally using multiple cores

The following modules can be executed as script:

  • bch: print content in json format if invoked with a BCH/BATCH file as argument
  • bchxml: produces an XML file when invoked with a BCH/BATCH file as argument
  • plot: produces a graphical report of a BCH/BATCH file
  • airgap: prints the base harmonic amplitude of the radial component of the airgap induction when invoked with the file name of an airgap induction file
  • mcv: print content in json format if invoked with a MC/MCV file as argument
  • dxfsl/conv: show geometry or create fsl from dxf

Usage

For many applications it is sufficient to import femagtools:

import femagtools

The version can be checked with:

femagtools.__version__
'1.0.nn'

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

femagtools-1.7.8.tar.gz (412.6 kB view details)

Uploaded Source

Built Distribution

femagtools-1.7.8-py3-none-any.whl (477.5 kB view details)

Uploaded Python 3

File details

Details for the file femagtools-1.7.8.tar.gz.

File metadata

  • Download URL: femagtools-1.7.8.tar.gz
  • Upload date:
  • Size: 412.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for femagtools-1.7.8.tar.gz
Algorithm Hash digest
SHA256 47e658ec564f6dfc336c7f47fd215ede89a2cf2b95e4a1ca75202361be30a30c
MD5 e29ca6d08f03a8262e556347735d5121
BLAKE2b-256 687443c08351589d76b848323ebab9e83d6b24e3fada00305316a6108db15e01

See more details on using hashes here.

File details

Details for the file femagtools-1.7.8-py3-none-any.whl.

File metadata

  • Download URL: femagtools-1.7.8-py3-none-any.whl
  • Upload date:
  • Size: 477.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for femagtools-1.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ee08287d31dcb6fe2b95a918515455218a6e45ed175941c93be48c261ea3322d
MD5 167d16b0e71d6d86d472c5b914b5d234
BLAKE2b-256 e7053e17b7177853823682c4ae8039e0143d1142078e9861116f285aac8c1ad1

See more details on using hashes here.

Supported by

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