Metadata-Version: 2.1
Name: FAST-OAD-core
Version: 1.8.4
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.9,<3.13
Classifier: Development Status :: 5 - Production/Stable
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Provides-Extra: mpi
Provides-Extra: mpi4py
Requires-Dist: Deprecated (>=1.2.13,<2.0.0)
Requires-Dist: aenum (>=3.1.0,<4.0.0)
Requires-Dist: anywidget (>=0.9.18,<0.10.0)
Requires-Dist: click (>=8.0.3,<9.0.0)
Requires-Dist: ensure (>=1.0.0,<2.0.0) ; python_version < "3.12"
Requires-Dist: ensure (>=1.0.4,<2.0.0) ; python_version >= "3.12" and python_version < "4.0"
Requires-Dist: importlib-metadata (>=4.2,<5.0) ; python_version < "3.10"
Requires-Dist: ipopo (>=1.0.0,<2.0.0) ; python_version < "3.10"
Requires-Dist: ipopo (>=3.0.0,<4.0.0) ; python_version >= "3.10" and python_version < "4.0"
Requires-Dist: ipysheet (>=0.5.0,<1)
Requires-Dist: ipywidgets (>=7.7.0,<9)
Requires-Dist: jsonschema (>=3.2.0,<5)
Requires-Dist: jupyterlab (>=3.4.7,<4.0.0) ; python_version < "3.12"
Requires-Dist: jupyterlab (>=4.2,<5.0) ; python_version >= "3.12" and python_version < "4.0"
Requires-Dist: lxml (>=4.6.5,<6) ; python_version < "3.11"
Requires-Dist: lxml (>=4.9.3,<6) ; python_version >= "3.11" and python_version < "4.0"
Requires-Dist: mpi4py (>=4.0.2,<5.0.0) ; extra == "mpi" or extra == "mpi4py"
Requires-Dist: numpy (>=1.23.2,<3)
Requires-Dist: openmdao (>3.27,<3.39)
Requires-Dist: pandas (>=1.3.4,<3) ; python_version < "3.11"
Requires-Dist: pandas (>=1.5.3,<3) ; python_version >= "3.11" and python_version < "3.12"
Requires-Dist: pandas (>=2.1.1,<3.0.0) ; python_version >= "3.12" and python_version < "4.0"
Requires-Dist: plotly (>=6.2.0,<7.0.0)
Requires-Dist: pyDOE3 (>=1.0.0,<2.0.0)
Requires-Dist: rich (>=14.0.0,<15.0.0)
Requires-Dist: ruamel.yaml (>=0.15.78,<0.18)
Requires-Dist: scipy (>=1.11.2,<2.0.0)
Requires-Dist: stdatm (>=0.4.2)
Requires-Dist: tabulate (>=0.8.9,<1)
Requires-Dist: tomlkit (>=0.5.3,<1)
Requires-Dist: wop (>=2.2.0,<3.0.0)
Description-Content-Type: text/markdown

<p align="center">
  <img src="https://github.com/fast-aircraft-design/FAST-OAD/blob/master/docs/img/FAST_OAD_logo2.jpg?raw=true" alt="FAST-OAD logo" width="600">
</p>

Future Aircraft Sizing Tool - Overall Aircraft Design
===============================================================
[![image](https://img.shields.io/pypi/v/fast-oad-core.svg)](https://pypi.python.org/pypi/fast-oad-core)
[![image](https://img.shields.io/pypi/pyversions/fast-oad-core.svg)](https://pypi.python.org/pypi/fast-oad-core)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

![Tests](https://github.com/fast-aircraft-design/FAST-OAD/workflows/Tests/badge.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9691f1d1430c45cf9c94bc342b4c6122)](https://app.codacy.com/gh/fast-aircraft-design/FAST-OAD/dashboard?utm_source=gh&utm_medium=referral&utm_content=&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)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Documentation Status](https://readthedocs.org/projects/fast-oad/badge/?version=stable)](https://fast-oad.readthedocs.io/)
[![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)
[![DOI](https://zenodo.org/badge/186570813.svg)](https://zenodo.org/badge/latestdoi/186570813)





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/developing models to match the need of your study.

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

> **Important notice:**
>
> Since version 1.3.0, FAST-OAD models for commercial transport aircraft have moved in 
> package  
> [FAST-OAD-CS25](https://pypi.org/project/fast-oad-cs25/). This package is installed along with 
> FAST-OAD, to keep backward compatibility.
> 
> Keep in mind that any update of these models will now come through new releases of FAST-OAD-CS25.
> 
> To get FAST-OAD without these models, you may install
> [FAST-OAD-core](https://pypi.org/project/fast-oad-core/).
> 
> :warning: Upgrading from an earlier version than 1.3 may break the `fastoad` command line (no 
> impact on PythonAPI). See [this issue](https://github.com/fast-aircraft-design/FAST-OAD/issues/425)
> for details and fix.

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.9.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.9/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
```

or, if you want the minimum installation without the CS25-related models:

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

