FreeQDSK
Read and write G-EQDSK, A-EQDSK, and P-EQDSK file formats, which are used to describe the tokamak fusion devices.
It has more features than other implementations, including aeqdsk and peqdsk formats, support for COCOS numbers != 1, some customisation of the header format.
It aims to be a well maintained community package, allowing to replace custom implementations by a feature complete, freely available implementation.
Installation
To install, you may need to update pip to the latest version:
$ python3 -m pip install --upgrade pip
You can then install using:
$ python3 -m pip install .
To run tests:
$ python3 -m install .[tests]
$ pytest -v
To build the docs:
$ python3 -m install .[docs]
$ cd docs
$ make html
Usage
A G-EQDSK file may be read using the geqdsk.read function:
from freeqdsk import geqdsk
with open(filename, "r") as f:
data = geqdsk.read(f)
The result is a dict containing data from the G-EQDSK file. To write a file:
with open(filename, "w") as f:
geqdsk.write(data, f)
Similarly, for A-EQDSK files:
from freeqdsk import aeqdsk
with open(filename, "r") as f:
data = aeqdsk.read(f)
with open(filename, "w") as f:
aeqdsk.write(data, f)
And again for P-EQDSK files:
from freeqdsk import peqdsk
with open(filename, "r") as f:
data = peqdsk.read(f)
with open(filename, "w") as f:
peqdsk.write(data, f)
Metadata
Release files for freeqdsk 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| freeqdsk-0.5.2.tar.gz | 201.8 kB | Without provenance | Details for freeqdsk-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| freeqdsk-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for freeqdsk-0.5.2-py3-none-any.whl |
Total release size: 227.6 kB
Release files / freeqdsk-0.5.2.tar.gz
| Download URL | freeqdsk-0.5.2.tar.gz |
|---|---|
| Size | 201.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7b40430f8368a9ac130d441d43aa50944b4165c8c44fc49b752836bd8e822b4b
|
|
BLAKE2b-256 checksum How to use checksums |
51cda98eea70d69fbee460278d54ca94370ad659f4245e96f1383471749c7e57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Release files / freeqdsk-0.5.2-py3-none-any.whl
| Download URL | freeqdsk-0.5.2-py3-none-any.whl |
|---|---|
| Size | 25.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36f9b614b03b7af930b5239e1f9e0ea2da4a8b16de8284b8e8c96a8160a08895
|
|
BLAKE2b-256 checksum How to use checksums |
3bc327c40f49900c200ff1655af3070cd5f9e796e39e85e3d7edb452a9874f30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Security for freeqdsk 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.