sapsan 0.6.5
Sapsan project
License: BSD
Requires Python: >=3.7, <3.11
Keywords: experiments,reproducibility,astrophysics

# Sapsan  <a href="https://sapsan-wiki.github.io/"><img src="https://github.com/pikarpov-LANL/Sapsan/blob/images/docs/images/logo3_black_slim_notitle_whitebg.png?raw=true"  alt="Sapsan logo" align="right" width="100"></a>

Sapsan is a pipeline for Machine Learning (ML) based turbulence modeling. While turbulence is important in a wide range of mediums, the pipeline primarily focuses on astrophysical applications. With Sapsan, one can create their own custom models or use either conventional or physics-informed ML approaches for turbulence modeling included with the pipeline ([estimators](https://sapsan-wiki.github.io/details/estimators/)). Sapsan is designed to take out all the hard work from data preparation and analysis, leaving you focused on ML model design, layer by layer.

Feel free to check out a website version at [sapsan.app](http://sapsan.app). The interface is identical to the GUI of the local version of Sapsan, except lacking the ability to edit the model code on the fly.

[![pypi](https://img.shields.io/pypi/v/sapsan?label=sapsan)](https://pypi.org/project/sapsan/)
[![pypi](https://img.shields.io/pypi/pyversions/sapsan)](https://pypi.org/project/sapsan/)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03199/status.svg)](https://doi.org/10.21105/joss.03199)

## [Documentation](https://sapsan-wiki.github.io/)

Please refer to Sapsan's Wiki for detailed installation, tutorials, troubleshooting, and API, as well as to learn more about the framework's capabilities.

## Quick Start

### 1. Install PyTorch (prerequisite)
Sapsan can be run on both CPU and GPU. Please follow the instructions on [PyTorch](https://pytorch.org/get-started/locally/) to install the latest version (torch>=1.7.1 & CUDA>=11.0).

### 2. Install via pip (recommended)
```
pip install sapsan
```

#### OR Clone from git
```
git clone https://github.com/pikarpov-LANL/Sapsan.git
cd Sapsan/
python setup.py install
```

Note: see [Installation Page](https://sapsan-wiki.github.io/overview/installation/) on the Wiki for complete instructions with Graphviz and Docker installation.

### 3. Test Installation

To make sure everything is alright, run a test of your setup:
```
sapsan test
```

### 4. Run Examples

To get started and familiarize yourself with the interface, feel free to run the included examples ([CNN](https://sapsan-wiki.github.io/details/estimators/#convolution-neural-network-cnn), [PIMLTurb](https://sapsan-wiki.github.io/details/estimators/#physics-informed-cnn-for-turbulence-modeling-pimlturb), [PICAE](https://sapsan-wiki.github.io/details/estimators/#physics-informed-convolutional-autoencoder-picae) or on 3D data, and [KRR](https://sapsan-wiki.github.io/details/estimators/#kernel-ridge-regression-krr) on 2D data). To copy the examples, type:
```
sapsan get_examples
```
This will create a folder `./sapsan_examples` with appropriate example jupyter notebooks.

### 5. Create Custom Projects!
To start a custom project, designing your own custom estimator, i.e., network, go ahead and run:
```
sapsan create {name}
```
where `{name}` should be replaced with your custom project name. As a result, a pre-filled template for the estimator, a jupyter notebook to run everything from, and Docker will be initialized.




-------
Sapsan has a BSD-style license, as found in the [LICENSE](https://github.com/pikarpov-LANL/Sapsan/blob/master/LICENSE) file.

© (or copyright) 2019. Triad National Security, LLC. All rights reserved.
This program was produced under U.S. Government contract 89233218CNA000001 for Los Alamos
National Laboratory (LANL), which is operated by Triad National Security, LLC for the U.S.
Department of Energy/National Nuclear Security Administration. All rights in the program are
reserved by Triad National Security, LLC, and the U.S. Department of Energy/National Nuclear
Security Administration. The Government is granted for itself and others acting on its behalf a
nonexclusive, paid-up, irrevocable worldwide license in this material to reproduce, prepare
derivative works, distribute copies to the public, perform publicly and display publicly, and to permit
others to do so.