Giter Club home page Giter Club logo

ascot5's Introduction

ASCOT5

Documentation

High-performance orbit-following code for fusion plasma physics and engineering.

New (and old) users are welcome to join our weekly meetings or Slack channel to discuss their research and plans with regards to ASCOT5.

This repository is maintained by ASCOT team in Aalto University and VTT Technical Research Centre of Finland.

Installation

Clone the repository:

git clone https://github.com/ascot4fusion/ascot5.git

Requirements

  • C compiler
  • HDF5
  • OpenMP
  • Python >= 3.10 (pre- and postprocessing)
  • MPI (optional)
  • VTK (optional, for 3D wall visualization)

Minimal Installation

For running ASCOT5 on this platform and performing pre- and post-processing on another platform:

cd ascot5
make ascot5_main

The binary is located at build/ascot5_main.

Full Installation

For full installation both ascot5_main and libascot.so are needed:

cd ascot5
make ascot5_main
make libascot

Python Library (a5py)

Useful even for minimal installation; it provides command-line tools for updating simulation options.

Create a virtual environment (optional but recommended), activate it, and install a5py:

cd ..
virtualenv -p python3 --system-site-packages ascotenv
source ascotenv/bin/activate
pip install -e ascot5/

How to Contribute

As an User:

As a Developer:

  • Don't let the code daunt you! We're here to assist with any feature contributions, whether it's a small post-processing tool, a new plot, or an enhancement of an existing feature.
  • Start by creating an issue, then (fork and) make a branch feature/<issuenumber>-issue from develop.
  • When ready to merge, create a pull request running automated tests on your branch.
  • Upon test completion and acceptance, your feature will be merged into develop for inclusion in the next release.

Licence

The ASCOT5 and associated programs are distributed under the terms of the GNU Lesser General Public License (LGPL). Please see the files COPYING and COPYING.LESSER for more information.

This has been done after the code was released to the original authors by the Dean of School of Science of Aalto University and discussion between the key contributors, including Jari Varje, Konsta Särkimäki, Antti Snicker and Simppa Äkäslompolo.

ascot5's People

Contributors

miekkasarki avatar lord-237 avatar sarkimk avatar sjjamsa avatar patrikollus avatar saskivi avatar jfrivero avatar aiheimo avatar otsooni avatar eerohirvijoki avatar m-bluteau avatar lazersos avatar henrikjaerleblad avatar asnicker avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.