| Name | femagtools JSON |
| Version |
1.6.5
JSON |
| download |
| home_page | None |
| Summary | Python API for FEMAG |
| upload_time | 2024-03-25 06:45:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright (c) 2016-2023, Semafor Informatik & Energie AG, Basel All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Introduction to Femagtools
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.
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:
```python
import femagtools
```
The version can be checked with:
```python
femagtools.__version__
```
'1.0.nn'
Raw data
{
"_id": null,
"home_page": null,
"name": "femagtools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Ronald Tanner <tar@semafor.ch>, Dapu Zhang <dzhang@gtisoft.com>, Beat Holm <hob@semafor.ch>, G\u00fcnther Amsler <amg@semafor.ch>, Nicolas Mauchle <mau@semafor.ch>",
"download_url": "https://files.pythonhosted.org/packages/8e/0c/825ce4db85b3f7dc107a94b84b168dcc4d7d641e5a9b2bee40113a1d8d08/femagtools-1.6.5.tar.gz",
"platform": null,
"description": "\n# Introduction to Femagtools\n\n\n\n\n\nFemagtools is an Open-Source Python-API for FEMAG offering following features:\n\n* run Femag with a FSL script file anywhere:\n locally (single and multi-core), remote (ZMQ), HT Condor, Cloud (Amazon AWS, Google Cloud), Docker\n* read I7/ISA7, NC, BCH/BATCH, PLT, ERG files\n* read and write MCV files (magnetizing curves)\n* create a variety of plots\n* create FSL files from model and calculation templates and/or user specific FSL\n* create FSL files from DXF\n* create and analyze symmetrical windings\n* sizing and parameter identification\n* calculate machine characteristics by using analytic machine models\n* execute parameter studies and multi-objective optimization\n\nThe 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.\n\nThe installation can be done in the usual ways with pip:\n\n```\npip install femagtools[all]\n```\n([all] pulls in all optional dependencies.\n\nFor details see the documentation <http://docs.semafor.ch/femagtools>\n\n## Modules and Scripts\n\nThe package provides following modules:\n\n* __mcv__, __tks__, __jhb__, __losscoeffs__: handling magnetizing curves and iron losses\n* __erg__, __bch__: read ERG, BCH/BATCH files created by FEMAG\n* __model__, __fsl__: create machine and calculation models\n* __femag__: manage the FEMAG calculation\n* __airgap__: read airgap induction file created by a previous calculation\n* __machine__: analytical machine models\n* __windings__: create and analyze windings\n* __grid__: running parameter variations\n* __opt__: running multi objective optimizations\n* __plot__: creating a variety of plots\n* __dxfsl__: create FSL from DXF\n* __isa7__, __nc__: read ISA7/I7, NC (NetCDF) files\n* __windings__: create and analyze windings\n* __forcedens__: read PLT files\n* __amazon__, __google__, __condor__, __multiproc__: engines for the calculation in Cloud and HTCondor environments or locally using multiple cores\n\nThe following modules can be executed as script:\n\n* __bch__: print content in json format if invoked with a BCH/BATCH file as argument\n* __bchxml__: produces an XML file when invoked with a BCH/BATCH file as argument\n* __plot__: produces a graphical report of a BCH/BATCH file\n* __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\n* __mcv__: print content in json format if invoked with a MC/MCV file as argument\n* __dxfsl/conv__: show geometry or create fsl from dxf\n\n## Usage\nFor many applications it is sufficient to import femagtools:\n\n\n```python\nimport femagtools\n```\n\nThe version can be checked with:\n\n\n```python\nfemagtools.__version__\n```\n\n\n\n\n '1.0.nn'\n",
"bugtrack_url": null,
"license": "Copyright (c) 2016-2023, Semafor Informatik & Energie AG, Basel All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Python API for FEMAG",
"version": "1.6.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "191c80f5df00c547c18fb7760094a18dec503323a5311063c9f3a28f67de79fd",
"md5": "c0e47f448c8290f1d53a6440a87e473c",
"sha256": "668ec651dff55dfe3aa9c0612f2d5e5edd8b19aa49dce557d8c559e6eec6a645"
},
"downloads": -1,
"filename": "femagtools-1.6.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0e47f448c8290f1d53a6440a87e473c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 441599,
"upload_time": "2024-03-25T06:45:31",
"upload_time_iso_8601": "2024-03-25T06:45:31.401357Z",
"url": "https://files.pythonhosted.org/packages/19/1c/80f5df00c547c18fb7760094a18dec503323a5311063c9f3a28f67de79fd/femagtools-1.6.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e0c825ce4db85b3f7dc107a94b84b168dcc4d7d641e5a9b2bee40113a1d8d08",
"md5": "4f93f09c362fe1538e6a5aac22bf1961",
"sha256": "3b90b3688e832ddefa9412c5f1cc35efd7147337c5e972f64897fba05f7d389d"
},
"downloads": -1,
"filename": "femagtools-1.6.5.tar.gz",
"has_sig": false,
"md5_digest": "4f93f09c362fe1538e6a5aac22bf1961",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 377083,
"upload_time": "2024-03-25T06:45:34",
"upload_time_iso_8601": "2024-03-25T06:45:34.834461Z",
"url": "https://files.pythonhosted.org/packages/8e/0c/825ce4db85b3f7dc107a94b84b168dcc4d7d641e5a9b2bee40113a1d8d08/femagtools-1.6.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 06:45:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "femagtools"
}
