Metadata-Version: 2.1
Name: fast-oad
Version: 1.1.0
Summary: FAST-OAD is a framework for performing rapid Overall Aircraft Design
Home-page: https://github.com/fast-aircraft-design/FAST-OAD
License: GPL-3.0-only
Keywords: aircraft,design,multi-disciplinary
Author: Christophe DAVID
Author-email: christophe.david@onera.fr
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Physics
Provides-Extra: jupyterlab
Requires-Dist: aenum (>=3.1.0,<4.0.0)
Requires-Dist: ensure (>=1.0.0,<2.0.0)
Requires-Dist: ipopo (>=1.0.0,<2.0.0)
Requires-Dist: ipysheet (>=0.4.0,<0.5.0)
Requires-Dist: ipywidgets (>=7.3.0,<8.0.0)
Requires-Dist: jsonschema (>=3.2.0,<4.0.0)
Requires-Dist: jupyter-client (!=7.0.0,!=7.0.1,!=7.0.2,!=7.0.3,!=7.0.4,!=7.0.5)
Requires-Dist: jupyterlab (>=2,<3); extra == "jupyterlab"
Requires-Dist: lxml (>=4.6.3,<5.0.0)
Requires-Dist: matplotlib (>=3.1.2,<4.0.0)
Requires-Dist: numpy (>=1.17.3,<2.0.0)
Requires-Dist: openmdao (>=3.10,<4.0)
Requires-Dist: pandas (>=1.1.0,<2.0.0)
Requires-Dist: plotly (>=4.5.0,<5.0.0)
Requires-Dist: ruamel.yaml (>=0.15.78,<0.18)
Requires-Dist: scipy (>=1.3.2,<2.0.0)
Requires-Dist: tabulate (>=0.8.9,<0.9.0)
Requires-Dist: tomlkit (>=0.5.3,<1)
Requires-Dist: wop (>=1.13.1,<2.0.0)
Description-Content-Type: text/markdown

![Tests](https://github.com/fast-aircraft-design/FAST-OAD/workflows/Tests/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/fast-oad/badge/?version=latest)](https://fast-oad.readthedocs.io/en/latest/?badge=latest)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9691f1d1430c45cf9c94bc342b4c6122)](https://www.codacy.com/gh/fast-aircraft-design/FAST-OAD?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=fast-aircraft-design/FAST-OAD&amp;utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/fast-aircraft-design/FAST-OAD/branch/master/graph/badge.svg)](https://codecov.io/gh/fast-aircraft-design/FAST-OAD)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fast-aircraft-design/FAST-OAD.git/latest-release?urlpath=lab%2Ftree%2Fsrc%2Ffastoad%2Fnotebooks)


FAST-OAD: Future Aircraft Sizing Tool - Overall Aircraft Design
===============================================================

FAST-OAD is a framework for performing rapid Overall Aircraft Design.

It proposes multi-disciplinary analysis and optimisation by relying on
the [OpenMDAO framework](https://openmdao.org/).

FAST-OAD allows easy switching between models for a same discipline, and
also adding/removing disciplines to match the need of your study.

Currently, FAST-OAD is bundled with models for commercial transport
aircraft of years 1990-2000. Other models will come, and you may create
your own models and use them instead of bundled ones.

More details can be found in the [official
documentation](https://fast-oad.readthedocs.io/).

>**_Note_**:
>
> Since version 1.0, FAST-OAD aims at providing a stable core software to 
> propose a safe base for development of custom models.
>
> Models in FAST-OAD are still a work in progress.


Want to try quickly?
--------------------
You can run FAST-OAD tutorials **without installation** using our
[Binder-hosted Jupyter notebooks](https://mybinder.org/v2/gh/fast-aircraft-design/FAST-OAD.git/latest-release?filepath=src%2Ffastoad%2Fnotebooks).


Install
-------

**Prerequisite**:FAST-OAD needs at least **Python 3.7.0**.

It is recommended (but not required) to install FAST-OAD in a virtual
environment ([conda](https://docs.conda.io/en/latest/),
[venv](https://docs.python.org/3.7/library/venv.html), ...)

Once Python is installed, FAST-OAD can be installed using pip.

> **Note**: If your network uses a proxy, you may have to do [some
> settings](https://pip.pypa.io/en/stable/user_guide/#using-a-proxy-server)
> for pip to work correctly

You can install the latest version with this command:

``` {.bash}
$ pip install --upgrade fast-oad
```

