Skip to content

Commit

Permalink
Merge pull request #73 from freegs-plasma/tutorial
Browse files Browse the repository at this point in the history
Tutorial
  • Loading branch information
ZedThree authored Apr 20, 2023
2 parents 6e964fd + 961d645 commit 9224a78
Show file tree
Hide file tree
Showing 3 changed files with 627 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ FreeGS: Free boundary Grad-Shafranov solver
[![py3comp](https://img.shields.io/badge/py3-compatible-brightgreen.svg)](https://img.shields.io/badge/py3-compatible-brightgreen.svg)
[![Build Status](https://github.com/freegs-plasma/freegs/workflows/Tests/badge.svg)](https://github.com/freegs-plasma/freegs/workflows/Tests/badge.svg)
[![codecov](https://codecov.io/gh/freegs-plasma/freegs/branch/master/graph/badge.svg?token=4dc6aHbu7K)](https://codecov.io/gh/freegs-plasma/freegs)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/freegs-plasma/freegs/tutorial?labpath=tutorial.ipynb)

This Python module calculates plasma equilibria for tokamak fusion experiments,
by solving the Grad-Shafranov equation with free boundaries. Given a set of coils,
Expand Down Expand Up @@ -50,6 +51,11 @@ Examples

The Jupyter notebooks contain examples wuth additional notes


* [tutorial.ipynb](./tutorial.ipynb)

Launch tutorial in [![MyBinder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/freegs-plasma/freegs/tutorial?labpath=tutorial.ipynb)

* MAST-example.ipynb

There are also some Python scripts to run short tests
Expand Down
1 change: 1 addition & 0 deletions freegs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
along with FreeGS. If not, see <http://www.gnu.org/licenses/>.
"""

from importlib_metadata import metadata

from .equilibrium import Equilibrium
Expand Down
Loading

0 comments on commit 9224a78

Please sign in to comment.