Metadata-Version: 2.1
Name: pysatModels
Version: 0.1.0
Summary: 'Supports model analysis and model-data comparisons'
Home-page: https://github.com/pysat/pysatModels
Author: Pysat Development Team
Author-email: pysat.developers@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Science/Research
Classifier: License :: Freely Distributable
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE

<div align="left">
        <img height="0" width="0px">
        <img width="20%" src="docs/images/pysatModels.png" alt="pysatModels" title="pysatModels"</img>
</div>

# pysatModels
[![Documentation Status](https://readthedocs.org/projects/pysatmodels/badge/?version=latest)](https://pysatmodels.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/pysat/pysatModels/actions/workflows/main.yml/badge.svg)](https://github.com/pysat/pysatModels/actions/workflows/main.yml/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/pysat/pysatModels/badge.svg?branch=main)](https://coveralls.io/github/pysat/pysatModels?branch=main)

pysatModels handles model-centric data loading through pysat and contains a
variety of tools to perform model-data analysis, including model validation.

Come join us on Slack! An invitation to the pysat workspace is available 
in the 'About' section of the
[pysat GitHub Repository.](https://github.com/pysat/pysat)

# Installation

The following instructions will allow you to install pysatModels and give some
examples on how to use the routines

## Prerequisites

pysatModels uses common Python modules, as well as modules developed by and for
the Space Physics community.  This module officially supports Python 3.6+.

| Common modules | Community modules |
| -------------- | ----------------- |
| numpy          | pysat             |
| pandas         | pyForecastTools   |
| requests       |                   |
| scipy          |                   |
| xarray         |                   |

## Installation through PyPi

```
pip install pysatmodels
```

## Installation from GitHub

1. Clone the git repository:
   `git clone https://github.com/pysat/pysatModels.git`

2. Install pysatModels:
   Change directories into the repository folder and run the setup.py file.
   There are a few ways you can do this:
   A. Install on the system (root privileges required):
      `sudo python3 setup.py install`
   B. Install at the user level:
      `python3 setup.py install --user`
   C. Install with the intent to develop locally:
      `python3 setup.py develop --user`

# Running the code

Examples for using the different pysatModels utilities are included in the
[documentation](https://pysatmodels.readthedocs.io/en/latest/).

If you're unfamiliar with pysat, tutorials and examples are available in its
[documentation](https://pysat.readthedocs.io/en/latest/).


