Quick start guide
This tool only supports Python.
Install
To use this tool you have to firstly install git. To install the git you can follow this link.(You can skip this stage if you already used git before.) If you are familiar with github then clone and install this vaft.
If you are not then write the below command in your cmd.
git clone https://github.com/vest-tokamak/vaft.git
cd vaft
python -m pip install -e .
python -m pip install -e ".[hsds]"
or
python -m pip install vaft
python -m pip install "vaft[hsds]"
Update
In the terminal, where you’re folder for git is in.
git pull
python -m pip install -e .
Configuration
Follow the below line in your command line. If you don’t have any authentication just use : username : reader password : test
>> hsconfigure
Enter new values or accept defaults in brackets with Enter.
Server endpoint []: http://147.46.36.244:5101
Username []: $your_username$
Password []: $your_password$
API Key [None]:
Testing connection...
connection ok
Quit? (Y/N)Y
Load
To load the data,
>>> import vaft
>>> shot_39915 = vaft.database.load_ods(39915, directory="public")
Save
Saving the data in server is not supported yet. Currently you can only save in local.
>>> import vaft
>>> shot_39915 = vaft.database.load_ods(39915, directory="public")
>>> vaft.database.save_ods(shot_39915, shot=39915, env="local")
Notebook example
If you want the full walkthrough with database background, connection checks, and ODS / IDS examples, see the notebook-based Examples guide and start from:
Representative notebook flow:
import vaft
connected = vaft.database.is_connect()
shots = vaft.database.exist_shot("public")
ods = vaft.database.load_ods(39915, directory="public")