Data

Tools

Indexes

Applications

Experiments

Open Source Science

eqdsk

g-eqdsk reading and writing with identification and conversion between COCOS versions

https://github.com/fusion-power-plant-framework/eqdsk

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary

Keywords

eqdsk equilibrium file-format nuclear-fusion plasma-physics
Last synced: 6 months ago · JSON representation ·

Repository

g-eqdsk reading and writing with identification and conversion between COCOS versions

Basic Info
Statistics
  • Stars: 6
  • Watchers: 5
  • Forks: 1
  • Open Issues: 3
  • Releases: 5
Topics
eqdsk equilibrium file-format nuclear-fusion plasma-physics
Created about 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codeowners

README.md

Eqdsk

Hatch project linting - Ruff Downloads 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:

bash pip install eqdsk

or for the most recent commit

bash 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:

```python from eqdsk import EQDSKInterface

EQDSKInterface.fromfile('file.json', nococos=True) ```

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

python 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:

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

CLI

This package includes a CLI tool for eqdsk exploration.

This can be accessed by running eqdsk in the terminal after installing the package (or in the Hatch cli environment, see CONTRIBUTING.md).

For more information on the CLI tool, run eqdsk --help.

Owner

  • Name: Fusion-Power-Plant-Framework
  • Login: Fusion-Power-Plant-Framework
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
authors:
  - family-names: Coleman
    given-names: M.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom; EUROfusion Consortium, Boltzmannstr.2, Garching, 85748, Germany

  - family-names: Cook
    given-names: J. E.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Franza
    given-names: F.
    affiliation: Karlsruher Institut für Technologie, Hermann-von-Helmholtz-Platz 1, 76344 Eggenstein-Leopoldshafen, Germany

  - family-names: Maione
    given-names: I. A.
    affiliation: Karlsruher Institut für Technologie, Hermann-von-Helmholtz-Platz 1, 76344 Eggenstein-Leopoldshafen, Germany

  - family-names: McIntosh
    given-names: S.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom; ITER Organization, Route de Vinon-sur-Verdon, CS 90 046, 13067 St Paul Lez Durance Cedex, France

  - family-names: Morris
    given-names: J.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Short
    given-names: D.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Blair
    given-names: A. I.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Funk
    given-names: O.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Saunders
    given-names: H.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

title: "eqdsk"
license: LGPL-2.1-or-later
repository-code: "https://github.com/Fusion-Power-Plant-Framework/eqdsk"
website: ""

GitHub Events

Total
  • Create event: 38
  • Release event: 1
  • Issues event: 4
  • Watch event: 4
  • Delete event: 33
  • Issue comment event: 2
  • Push event: 69
  • Pull request event: 76
  • Pull request review event: 36
Last Year
  • Create event: 38
  • Release event: 1
  • Issues event: 4
  • Watch event: 4
  • Delete event: 33
  • Issue comment event: 2
  • Push event: 69
  • Pull request event: 76
  • Pull request review event: 36

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 27
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 23
Past Year
  • Issues: 0
  • Pull requests: 27
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 23
View more stats
Top Authors
Issue Authors
  • je-cook (7)
  • oliverfunk (2)
Pull Request Authors
  • pre-commit-ci[bot] (30)
  • je-cook (21)
  • oliverfunk (4)
Top Labels
Issue Labels
enhancement (3) quality (1) CI (1) documentation (1)
Pull Request Labels
CI (20) dependencies (14) enhancement (7) bug (4) quality (3) documentation (1) tests (1) imas (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 22,174 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: eqdsk

A reader, writer and converter for the eqdsk format

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 22,174 Last month
Rankings
Dependent packages count: 10.8%
Average: 35.9%
Dependent repos count: 61.0%
Maintainers (1)
fppf
Last synced: 6 months ago

Dependencies

.github/workflows/actions/hatch-lint/action.yml actions
.github/workflows/actions/setup-hatch/action.yml actions
  • actions/setup-python v5 composite
.github/workflows/publish.yml actions
  • ./.github/workflows/actions/setup-hatch * composite
  • actions/checkout v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/release.yml actions
  • actions/checkout v4 composite
pyproject.toml pypi
  • fortranformat *
  • numpy *
.github/workflows/main_and_pr.yml actions
  • ./.github/workflows/actions/hatch-lint * composite
  • ./.github/workflows/actions/setup-hatch * composite
  • actions/checkout v4 composite
.github/workflows/publish-docs.yml actions
  • ./.github/workflows/actions/setup-hatch * composite
  • actions/cache v4 composite
  • actions/checkout v4 composite