<p align="center">
<img src="docs/img/FAST_OAD_logo2.jpg" alt="FAST-OAD logo" width="600">
</p>
Future Aircraft Sizing Tool - Overall Aircraft Design
===============================================================
![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)
[![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)
[![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.8.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
```
or, if you want the minimum installation without the CS25-related models:
``` {.bash}
$ pip install --upgrade fast-oad-core
```
Raw data
{
"_id": null,
"home_page": "https://github.com/fast-aircraft-design/FAST-OAD",
"name": "FAST-OAD-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": null,
"keywords": "aircraft, design, multi-disciplinary",
"author": "Christophe DAVID",
"author_email": "christophe.david@onera.fr",
"download_url": "https://files.pythonhosted.org/packages/a5/9d/c5f42f595646c3221c805bf5731bc4a8d46c382d96e82bc0e516c76e9470/fast_oad_core-1.7.4.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"docs/img/FAST_OAD_logo2.jpg\" alt=\"FAST-OAD logo\" width=\"600\">\n</p>\n\nFuture Aircraft Sizing Tool - Overall Aircraft Design\n===============================================================\n\n![Tests](https://github.com/fast-aircraft-design/FAST-OAD/workflows/Tests/badge.svg)\n[![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)\n[![codecov](https://codecov.io/gh/fast-aircraft-design/FAST-OAD/branch/master/graph/badge.svg)](https://codecov.io/gh/fast-aircraft-design/FAST-OAD)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n[![Documentation Status](https://readthedocs.org/projects/fast-oad/badge/?version=stable)](https://fast-oad.readthedocs.io/)\n[![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)\n[![DOI](https://zenodo.org/badge/186570813.svg)](https://zenodo.org/badge/latestdoi/186570813)\n\n\n\n\n\nFAST-OAD is a framework for performing rapid Overall Aircraft Design.\n\nIt proposes multi-disciplinary analysis and optimisation by relying on\nthe [OpenMDAO framework](https://openmdao.org/).\n\nFAST-OAD allows easy switching between models for a same discipline, and\nalso adding/removing/developing models to match the need of your study.\n\nMore details can be found in the [official documentation](https://fast-oad.readthedocs.io/).\n\n> **Important notice:**\n>\n> Since version 1.3.0, FAST-OAD models for commercial transport aircraft have moved in \n> package \n> [FAST-OAD-CS25](https://pypi.org/project/fast-oad-cs25/). This package is installed along with \n> FAST-OAD, to keep backward compatibility.\n> \n> Keep in mind that any update of these models will now come through new releases of FAST-OAD-CS25.\n> \n> To get FAST-OAD without these models, you may install\n> [FAST-OAD-core](https://pypi.org/project/fast-oad-core/).\n> \n> :warning: Upgrading from an earlier version than 1.3 may break the `fastoad` command line (no \n> impact on PythonAPI). See [this issue](https://github.com/fast-aircraft-design/FAST-OAD/issues/425)\n> for details and fix.\n\nWant to try quickly?\n--------------------\nYou can run FAST-OAD tutorials **without installation** using our\n[Binder-hosted Jupyter notebooks](https://mybinder.org/v2/gh/fast-aircraft-design/FAST-OAD.git/latest-release?filepath=src%2Ffastoad%2Fnotebooks).\n\n\nInstall\n-------\n\n**Prerequisite**:FAST-OAD needs at least **Python 3.8.0**.\n\nIt is recommended (but not required) to install FAST-OAD in a virtual\nenvironment ([conda](https://docs.conda.io/en/latest/),\n[venv](https://docs.python.org/3.7/library/venv.html), ...)\n\nOnce Python is installed, FAST-OAD can be installed using pip.\n\n> **Note**: If your network uses a proxy, you may have to do [some\n> settings](https://pip.pypa.io/en/stable/user_guide/#using-a-proxy-server)\n> for pip to work correctly\n\nYou can install the latest version with this command:\n\n``` {.bash}\n$ pip install --upgrade fast-oad\n```\n\nor, if you want the minimum installation without the CS25-related models:\n\n``` {.bash}\n$ pip install --upgrade fast-oad-core\n```\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "FAST-OAD is a framework for performing rapid Overall Aircraft Design",
"version": "1.7.4",
"project_urls": {
"Homepage": "https://github.com/fast-aircraft-design/FAST-OAD"
},
"split_keywords": [
"aircraft",
" design",
" multi-disciplinary"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f94abda3ace08c8a01a49bcec7e5337e3a13ec520b14cb19725ff716a1d727f",
"md5": "f943296b41ea23df25e8c21af8966989",
"sha256": "0390cf22e87fefab3b822e462cb0bb3f30d5687346e422c76d28d79a6838d71c"
},
"downloads": -1,
"filename": "fast_oad_core-1.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f943296b41ea23df25e8c21af8966989",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 934841,
"upload_time": "2024-07-23T10:11:46",
"upload_time_iso_8601": "2024-07-23T10:11:46.995022Z",
"url": "https://files.pythonhosted.org/packages/7f/94/abda3ace08c8a01a49bcec7e5337e3a13ec520b14cb19725ff716a1d727f/fast_oad_core-1.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a59dc5f42f595646c3221c805bf5731bc4a8d46c382d96e82bc0e516c76e9470",
"md5": "5e7d65a6529e8f88c88792d1f586ef9f",
"sha256": "7b62f335e3e4280b126e9ea147ce0a4cb4e2b42c6f199b033981c10d1948b3d3"
},
"downloads": -1,
"filename": "fast_oad_core-1.7.4.tar.gz",
"has_sig": false,
"md5_digest": "5e7d65a6529e8f88c88792d1f586ef9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 798681,
"upload_time": "2024-07-23T10:11:48",
"upload_time_iso_8601": "2024-07-23T10:11:48.675376Z",
"url": "https://files.pythonhosted.org/packages/a5/9d/c5f42f595646c3221c805bf5731bc4a8d46c382d96e82bc0e516c76e9470/fast_oad_core-1.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 10:11:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fast-aircraft-design",
"github_project": "FAST-OAD",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fast-oad-core"
}