Metadata-Version: 2.1
Name: fast-oad-cs23
Version: 1.0.2
Summary: FAST-OAD-CS23 is a framework for performing rapid Overall Aircraft Design for General Aircraft
Home-page: https://github.com/supaero-aircraft-design/FAST-GA
License: GPL-3.0-only
Keywords: aircraft,design,multi-disciplinary
Author: Florent LUTZ
Author-email: Florent.LUTZ2@isae-supaero.fr
Requires-Python: >=3.7,<3.10
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.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Physics
Provides-Extra: jupyterlab
Requires-Dist: fast-oad-core (>=1.3.3,<1.4.0)
Requires-Dist: openmdao (<3.18.0)
Requires-Dist: stdatm (==0.2.0)
Description-Content-Type: text/markdown

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

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ee153dd5e82d41e7b2f3a964ef5756f5)](https://www.codacy.com/gh/supaero-aircraft-design/FAST-GA/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=supaero-aircraft-design/FAST-GA&amp;utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/supaero-aircraft-design/FAST-GA/branch/main/graph/badge.svg?token=VZEDUOFE8V)](https://codecov.io/gh/supaero-aircraft-design/FAST-GA)
[![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/supaero-aircraft-design/FAST-GA/HEAD?urlpath=lab%2Ftree%2Fsrc%2Ffastga%2Fnotebooks)

FAST-(OAD)-GA: Future Aircraft Sizing Tool - Overall Aircraft Design (General Aviation extension)
===============================================================================================

FAST-(OAD)-GA is derived from FAST-OAD framework performing rapid Overall Aircraft Design.

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

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

Currently, FAST-(OAD)-GA is bundled with models for general aviation and conventional
propulsion (ICE propeller based). Other models will come soon, 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-ga.readthedocs.io/).

Want to try quickly ?
-------

You can run FAST-OAD-GA notebooks number 1, 2 and 3 using our [Binder-hosted Jupyter notebooks](https://mybinder.org/v2/gh/supaero-aircraft-design/FAST-GA/HEAD). Just go to src/fastga/notebooks/tutorial after you click the link.

As these Binder-hosted notebooks are not setup to work in a Windows environment, external applications such as OpenVSP and Xfoil can't be run. Therefore, notebook number 4 will not fully work.

Install
-------

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

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

The FAST-(OAD)-GA is not registered for a direct pip install.
Yet an installation using pip command is possible. To do so, use command:
**pip install fast-oad-cs23==xxx**, where xxx is the version number (ex: 1.0.0).

