Welcome to TokSearch
TokSearch is a Python package for parallel retrieving, processing, and filtering of arbitrary-dimension fusion experimental data. TokSearch provides a high level API for extracting information from many shots, along with useful classes for low level data retrieval and manipulation.
The fundamental class in TokSearch is the Pipeline
. A Pipeline
object takes a list of shots and, for each shot in the list, creates a dict-like object called a Record
. The Pipeline
object then provides methods for defining a sequence of processing steps to apply to each record. These processing steps include:
- Passing user-defined functions to the pipeline via the
map
method.
or...
- Using a set of built-in methods, such as
fetch
,fetch_dataset
,align
,keep
, ordiscard
.
The Pipeline
also provides a where
method which takes as input a user-defined function that returns a boolean value. If the function evaluates to False
for a record, then that record is removed from the pipeline.
Installation
TokSearch is available on the ga-fdp
conda channel.
In the near future, we will provide a way to install TokSearch directly from PyPI using pip.
Installation with Conda in an existing environment
To install in an existing conda environment, run:
or equivalently
You can substitute mamba
for conda
if you prefer.
Installation with Conda in a new environment
Optionally, you can create a new environment:
Installation from Source
At the moment, the cleanest way to install TokSearch from source is to first set up a Conda/Mamba environment with the required dependencies, and then install TokSearch from the local clone of the repository. Here are the steps:
First, clone the repository, then from the root directory of the repository, run:
or
You can also specify the -p
flag to specify the path to the environment. For example:
Then, activate the environment:
Finally, install TokSearch itself: