<commit_before>.. SeisFlows documentation master file, created by
   sphinx-quickstart on Thu Oct 16 14:47:24 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

What is SeisFlows?
==================

SeisFlows is an open source seismic inversion package with three main goals:

- deliver a complete, customizable adjoint tomography and full waveform inversion workflow

- provide a framework for research in regional, global, and exploration tomography

- avoid code duplication across 2D, 3D, and global solver packages


Installation
============

To install Seisflows, first clone the repository::

    git clone https://github.com/PrincetonUniversity/seisflows


Then set environment variables. If using bash, add the following lines to ``.bash_profile`` or ``.bashrc``::

    export PATH=$PATH:/path/to/seisflows/scripts
    export PYTHONPATH=$PYTHONPATH:/path/to/seisflows
    export PYTHONUNBUFFERED="TRUE"


Getting Started
===============

Perhaps the easiest way to get started is to run a few examples.  Users with accounts on ``tiger.princeton.edu`` can start directly with these :doc:`instructions <tiger>`.  Other users must await the arrival of an ftp download server. 


Documentation<commit_msg>edited docs<commit_after>.. SeisFlows documentation master file, created by
   sphinx-quickstart on Thu Oct 16 14:47:24 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

What is SeisFlows?
==================

SeisFlows is an open source seismic inversion package that:

- delivers a complete, customizable adjoint tomography and full waveform inversion workflow

- provides a framework for research in regional, global, and exploration tomography


Installation
============

To install Seisflows, first clone the repository::

    git clone https://github.com/PrincetonUniversity/seisflows


Then set environment variables. If using bash, add the following lines to ``.bash_profile`` or ``.bashrc``::

    export PATH=$PATH:/path/to/seisflows/scripts
    export PYTHONPATH=$PYTHONPATH:/path/to/seisflows
    export PYTHONUNBUFFERED="TRUE"


Getting Started
===============

Perhaps the easiest way to get started is to run a few examples.  Users with accounts on ``tiger.princeton.edu`` can start directly with these :doc:`instructions <tiger>`.  Other users must await the arrival of an ftp download server. 


Documentation
{'fraction_non_alphanumeric': 0.097708082026538, 'fraction_numerical': 0.010454362685967028, 'mean_word_length': 4.603603603603603, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4574969', 'n_tokens_mistral': 737, 'n_tokens_neox': 651, 'n_words': 289}