# PyFME

**Repository Path**: heastdream/PyFME

## Basic Information

- **Project Name**: PyFME
- **Description**: Python Flight Mechanics Engine
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-27
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

PyFME
=====

:Name: PyFME
:Description: Python Flight Mechanics Engine
:Website: https://github.com/AeroPython/PyFME
:Author: AeroPython Team <aeropython@groups.io>
:Version: 0.2.dev0

.. |travisci| image:: https://img.shields.io/travis/AeroPython/PyFME/master.svg?style=flat-square
   :target: https://travis-ci.org/AeroPython/PyFME

.. |codecov| image:: https://img.shields.io/codecov/c/github/AeroPython/PyFME.svg?style=flat-square
   :target: https://codecov.io/gh/AeroPython/PyFME?branch=master

.. |docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square
   :target: http://pyfme.readthedocs.io/en/latest/?badge=latest

.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
   :target: https://github.com/AeroPython/PyFME/raw/master/COPYING

.. |mailing| image:: https://img.shields.io/badge/mailing%20list-groups.io-8cbcd1.svg?style=flat-square
   :target: https://groups.io/g/aeropython
   
.. |mybinder| image:: https://mybinder.org/badge.svg
   :target: https://mybinder.org/v2/gh/AeroPython/PyFME/master?urlpath=notebooks%2Fexamples%2FHow%2520it%2520works.ipynb

|travisci| |codecov| |mybinder| |docs| |license| |mailing| 

.. image:: http://pyfme.readthedocs.io/en/latest/_images/logo_300.png
   :target: https://github.com/AeroPython/PyFME
   :alt: PyFME
   :width: 300px
   :align: center

**If you want to know how PyFME works, how to collaborate or get our contact information,
please visit our** `wiki`_

.. _`wiki`: https://github.com/AeroPython/PyFME/wiki

Example Notebook
----------------

See how it works: visit the our example Notebook!: 
https://mybinder.org/v2/gh/AeroPython/PyFME/master?urlpath=notebooks%2Fexamples%2FHow%2520it%2520works.ipynb

How to install
--------------

PyFME is not yet in PyPI, so you can install directly from the source code::

    $ pip install https://github.com/AeroPython/PyFME/archive/0.1.x.zip

If you have git installed, you can also try::

    $ pip install git+https://github.com/AeroPython/PyFME.git

If you get any installation or compilation errors, make sure you have the latest pip and setuptools::

    $ pip install --upgrade pip setuptools

How to run the tests
--------------------

Install in editable mode and call `py.test`::

    $ pip install -e .
    $ py.test