Skip to content

Commit

Permalink
Adding link to documentation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bendudson committed Jan 23, 2018
1 parent 040840c commit fc85603
Showing 1 changed file with 29 additions and 15 deletions.
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,24 @@ FreeGS: Free boundary Grad-Shafranov solver
This Python module solves the Grad-Shafranov equation for axisymmetric
plasma equilibria, mainly for free boundary calculations.

Copyright 2016 Ben Dudson, University of York. Email: benjamin.dudson@york.ac.uk

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

Installing
----------

FreeGS is available on PyPI

$ pip install --user freegs

or clone/download this repository and run setup:

$ git clone https://github.com/bendudson/freegs.git
$ cd freegs
$ python setup.py install --user

Documentation
-------------

The manual is in the `docs` subdirectory, and [hosted here on readthedocs](http://freegs.readthedocs.io/en/latest/).

Examples
--------

Expand Down Expand Up @@ -84,6 +80,24 @@ The "freegs" module consists of the following files:
* **picard.py** - Nonlinear solver, iterating the profiles and constraints
* **plotting.py** - Plotting routines using matplotlib

License
-------

Copyright 2016-2018 Ben Dudson, University of York. Email: benjamin.dudson@york.ac.uk

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

References
----------

Expand Down

0 comments on commit fc85603

Please sign in to comment.