https://github.com/pysat/pysatmodels

Interface for model analysis and model-data comparisons within the pysat ecosystem
https://github.com/pysat/pysatmodels

comparison data dineof model pysat python sami2 tie-gcm validation

Last synced: 7 months ago
JSON representation

Interface for model analysis and model-data comparisons within the pysat ecosystem

• Host: GitHub
• URL: https://github.com/pysat/pysatmodels
• Owner: pysat
• License: bsd-3-clause
• Created: 2019-09-18T17:07:38.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-03-20T15:46:48.000Z (11 months ago)
• Last Synced: 2025-06-28T21:05:23.090Z (7 months ago)
• Topics: comparison, data, dineof, model, pysat, python, sami2, tie-gcm, validation
• Language: Python
• Homepage:
• Size: 3.7 MB
• Stars: 8
• Watchers: 3
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Support: docs/supported_models.rst
  • Zenodo: .zenodo.json

Awesome Lists containing this project

README

          


        

        



# 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/).