Metadata-Version: 2.1
Name: pystrat
Version: 1.0.0
Summary: Convenient stratigraphic plotting and analysis in Python.
Home-page: https://github.com/yuempark/pystrat
Author: Yuem Park
Author-email: yuempark@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# pystrat

<img src="https://raw.githubusercontent.com/yuempark/pystrat/master/images/pystrat-logo.png" width="100" height="100">

Convenient stratigraphic plotting and analysis in Python.

*pystrat* seeks to make the plotting and analysis of stratigraphic data reproducible and simple.

## Installation

### PyPI

To install the latest release from PyPI, simply enter the following at the command prompt:

```
pip install pystrat
```

### GitHub

To install the latest version of the code directly from GitHub:

1. Open Terminal.

2. Change the current working directory to the location where you want the cloned directory to be made.

```
cd <path/to/directory/>
```

3. Copy, paste, and execute the following:

```
git clone https://github.com/yuempark/pystrat.git
```

4. Set the path by opening `.bash_profile` or `.bashrc` (usually in your root directory) and adding the following:

```
export PATH=$PATH:<path/to/directory>/pystrat
export PYTHONPATH=$PYTHONPATH:<path/to/directory>/pystrat
```

* If you don't want to mess with your `.bash_profile` or `.bashrc`, just make sure that your code is in the same directory as `pystrat-tutorial.ipynb`.

## Usage

A tutorial on how to use the main features of *pystrat* are included in `pystrat-tutorial.ipynb`.

## Contributing

We can make *pystrat* better - feel free to [raise an issue](https://github.com/yuempark/pystrat/issues) or [make a pull request](https://github.com/yuempark/pystrat/pulls)!


