Skip to main content

A reader, writer and converter for the eqdsk format

Project description

Eqdsk

Hatch project linting - Ruff Actions status

An EQDSK reader and writer for GEQDSK (more soon), with COCOS identification and conversion.

There is support for writing an eqdsk to a JSON format (which is now preferred).

We have extended the EQDSK standard to optionally allow for the definition of a CoilSet.

Setup

We are pip installable therefore for the most recent release:

pip install eqdsk

or for the most recent commit

pip install git+https://github.com/Fusion-Power-Plant-Framework/eqdsk.git

For a developer setup please see CONTRIBUTING.md

Basic Usage

To read in an eqdsk (json or eqdsk) in its raw state:

from eqdsk import EQDSKInterface

EQDSKInterface.from_file('file.json', no_cocos=True)

To read in an eqdsk file with a known cocos format and convert it to a given cocos format:

EQDSKInterface.from_file('file.eqdsk', from_cocos=11, to_cocos=17)

Alternatively if the direction (clockwise or anticlockwise) and the units of phi (V.s or V.s/rad) are known, the cocos standard will be calculated for you:

EQDSKInterface.from_file('file.eqdsk', clockwise_phi=True, volt_seconds_per_radian=True)

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

eqdsk-0.4.0.tar.gz (273.9 kB view details)

Uploaded Source

Built Distribution

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

eqdsk-0.4.0-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

Details for the file eqdsk-0.4.0.tar.gz.

File metadata

  • Download URL: eqdsk-0.4.0.tar.gz
  • Upload date:
  • Size: 273.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for eqdsk-0.4.0.tar.gz
Algorithm Hash digest
SHA256 c3ee81c083a720b73569dccdb1f836a5e74f285caa9e6741b1f41908dffb51dd
MD5 dcb5be8217402f05282a1f47e73c2984
BLAKE2b-256 3981527fcd8b76f4ea5e8463acf696eafd5536c32e17a240b8058409f1f7d277

See more details on using hashes here.

File details

Details for the file eqdsk-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: eqdsk-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 25.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for eqdsk-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eac6fa10297cd036598cf926e06658cba78e190614cc702b535db3df09096b21
MD5 b64311ce2cb296ab7b623f185dac3dc7
BLAKE2b-256 0d02d03c4521445e3db3f5a853547a07c2c2f94f35398ef31eba28a9e57c8651

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