Skip to main content

Sapsan project

Project description

Sapsan Sapsan logo

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). 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. 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 pypi DOI

Sapsan's Wiki

Please refer to Sapsan's Wiki to learn more about the framework's details and capabilities.

Quick Start

1. Install PyTorch (prerequisite)

Sapsan can be run on both CPU and GPU. Please follow the instructions on PyTorch 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 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, PIMLTurb, PICAE or on 3D data, and 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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sapsan-0.6.0.tar.gz (21.3 MB view details)

Uploaded Source

Built Distribution

sapsan-0.6.0-py3-none-any.whl (21.3 MB view details)

Uploaded Python 3

File details

Details for the file sapsan-0.6.0.tar.gz.

File metadata

  • Download URL: sapsan-0.6.0.tar.gz
  • Upload date:
  • Size: 21.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for sapsan-0.6.0.tar.gz
Algorithm Hash digest
SHA256 ffdd1729697794c6c532449cbe3e7a92095c2a2d17e610d7682ddc6ca9933a7e
MD5 e062b170806204bbfebab2a42bb8b877
BLAKE2b-256 b66e0959a54ad03c46a8a60bc8e892d98065a69e34f32cc9c6f7e744fe6d2ee0

See more details on using hashes here.

Provenance

File details

Details for the file sapsan-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: sapsan-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for sapsan-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f8d5f7436b5b0ca2ef7e5dcc717cf4ce155c43c7851357f8c8f0078afb15149
MD5 7d28165adec4b739e5de6553216836d5
BLAKE2b-256 3653ed3d7e5ba28fce03a986940a17ff5e6405b2b2babd717694ac144ea1001d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page