<!--
Consolidated Aircraft Recipes in Python (carpy)
Copyright (C) 2023 Yaseen Reza
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
-->
<h2 align="center"><p>Consolidated Aircraft Recipes in Python</p></h2>
<p align="center">Yaseen Reza</p>
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://www.python.org/downloads/release/python-395/)
[](https://badge.fury.io/py/carpy)
CARPy is an open source project for those interested in the methodology and
approach to the conceptual-level design of fixed-wing aircraft. This library
provides its users with access to a variety of design tools for conceptual
analysis - CARPy is designed to complement and not substitute a comprehensive
and detailed study of a vehicle concept.
- [Source Code](https://github.com/yaseen157/carpy)
- [Jupyter Notebooks](https://github.com/yaseen157/carpy/tree/main/docs/source)
- [Contributors Guide](CONTRIBUTORS_GUIDE.md)
Users will find:
- Virtual (design) atmospheres
- Hassle-free conversions between systems of units
- Constraint Analysis Methods
- `[WorkInProgress]` Propulsion models and Engine Performance Decks
- *...and much more* `[WorkInProgress]`
For a detailed description of the library, please consult the documentation. To
get started, follow the instructions below.
**Continuous Integration Status** (CircleCI):\
[](https://dl.circleci.com/status-badge/redirect/gh/yaseen157/carpy/tree/main)
## ✔️ Getting Started
### Installation
`carpy` is written for (and tested in) Python version 3.9.5.
On most systems you should be able to simply open an operating system terminal
and at the command prompt type
$ pip install carpy
or
$ python -m pip install carpy
NOTE: `pip` is a Python package; if it is not available on your system, download
[get-pip.py](https://bootstrap.pypa.io/get-pip.py) and run it in Python by
entering
$ python get-pip.py
at the operating system prompt.
If you already have a version of carpy installed and are simply trying to
upgrade, use the `--upgrade` flag:
$ pip install --upgrade carpy
An alternative approach to installing carpy is to clone the GitHub repository
using `git`, by typing
$ git clone https://github.com/yaseen157/carpy.git
at the command prompt. Following a successful clone of files to your machine,
navigate to the library root (this contains the file `pyproject.toml`). At this
point, you may enter the following:
$ python -m pip install ./
Alternatively, adventurous users who want an editable install to make any
customisations in their local build should use the `--editable` flag:
$ python -m pip install -e ./
Should you find that your installation requires packages you do not have in your
current Python environment, install them by typing this in the same prompt:
$ python -m pip install -r requirements.txt
### A 'Hello world' example: Atmospheric properties
There are several options for running the examples shown here: you could copy
and paste them into a `.py` file, save it and run it in Python, or you could
enter the lines, in sequence, at the prompt of a Python terminal. You could also
copy and paste them into a Jupyter notebook
(`.ipynb` file) cell and execute the cell.
```python
"""'Hello World' example to introduce users to CARPy atmospheres."""
from carpy.environment import ISA1975
from carpy.utility import Quantity
# Instantiate an atmosphere object:
# International Standard Atmosphere with a +10C offset
atm = ISA1975(T_offset=10)
# Query the ambient density in this model at 41,000 feet
# noinspection PyTypeChecker
print(f"{atm} density at 41,000 feet:",
atm.rho(altitude=Quantity(41_000, "ft")))
```
You should see the following output:
ISA1975(+10°C) density at 41,000 feet: 0.28740209 kg m⁻³
You can learn more about `CARPy`'s capabilities through the exemplary
[notebooks](./docs/source/).
## 🐍 Acknowledgements
The library was authored by:
- Yaseen Reza
Raw data
{
"_id": null,
"home_page": "",
"name": "carpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9.5",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Yaseen Reza <yaseen605@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/99/d0/2715f71ff2addd18516b80da9e6cd0d4547d76afcfe6faa389f0bc74ad9e/carpy-0.0.6.post3.tar.gz",
"platform": null,
"description": "<!--\n Consolidated Aircraft Recipes in Python (carpy)\n Copyright (C) 2023 Yaseen Reza\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see <https://www.gnu.org/licenses/>.\n-->\n\n\n<h2 align=\"center\"><p>Consolidated Aircraft Recipes in Python</p></h2>\n<p align=\"center\">Yaseen Reza</p>\n\n[](https://www.gnu.org/licenses/gpl-3.0)\n[](https://www.python.org/downloads/release/python-395/)\n[](https://badge.fury.io/py/carpy)\n\nCARPy is an open source project for those interested in the methodology and\napproach to the conceptual-level design of fixed-wing aircraft. This library\nprovides its users with access to a variety of design tools for conceptual\nanalysis - CARPy is designed to complement and not substitute a comprehensive\nand detailed study of a vehicle concept.\n\n- [Source Code](https://github.com/yaseen157/carpy)\n- [Jupyter Notebooks](https://github.com/yaseen157/carpy/tree/main/docs/source)\n- [Contributors Guide](CONTRIBUTORS_GUIDE.md)\n\nUsers will find:\n\n- Virtual (design) atmospheres\n- Hassle-free conversions between systems of units\n- Constraint Analysis Methods\n- `[WorkInProgress]` Propulsion models and Engine Performance Decks\n- *...and much more* `[WorkInProgress]`\n\nFor a detailed description of the library, please consult the documentation. To\nget started, follow the instructions below.\n\n**Continuous Integration Status** (CircleCI):\\\n[](https://dl.circleci.com/status-badge/redirect/gh/yaseen157/carpy/tree/main)\n\n## \u2714\ufe0f Getting Started\n\n### Installation\n\n`carpy` is written for (and tested in) Python version 3.9.5.\n\nOn most systems you should be able to simply open an operating system terminal\nand at the command prompt type\n\n $ pip install carpy\n\nor\n\n $ python -m pip install carpy\n\nNOTE: `pip` is a Python package; if it is not available on your system, download\n[get-pip.py](https://bootstrap.pypa.io/get-pip.py) and run it in Python by\nentering\n\n $ python get-pip.py\n\nat the operating system prompt.\n\nIf you already have a version of carpy installed and are simply trying to\nupgrade, use the `--upgrade` flag:\n\n $ pip install --upgrade carpy\n\nAn alternative approach to installing carpy is to clone the GitHub repository\nusing `git`, by typing\n\n $ git clone https://github.com/yaseen157/carpy.git\n\nat the command prompt. Following a successful clone of files to your machine,\nnavigate to the library root (this contains the file `pyproject.toml`). At this\npoint, you may enter the following:\n\n $ python -m pip install ./\n\nAlternatively, adventurous users who want an editable install to make any\ncustomisations in their local build should use the `--editable` flag:\n\n $ python -m pip install -e ./\n\nShould you find that your installation requires packages you do not have in your\ncurrent Python environment, install them by typing this in the same prompt:\n\n $ python -m pip install -r requirements.txt\n\n### A 'Hello world' example: Atmospheric properties\n\nThere are several options for running the examples shown here: you could copy\nand paste them into a `.py` file, save it and run it in Python, or you could\nenter the lines, in sequence, at the prompt of a Python terminal. You could also\ncopy and paste them into a Jupyter notebook\n(`.ipynb` file) cell and execute the cell.\n\n```python\n\"\"\"'Hello World' example to introduce users to CARPy atmospheres.\"\"\"\nfrom carpy.environment import ISA1975\nfrom carpy.utility import Quantity\n\n# Instantiate an atmosphere object:\n# International Standard Atmosphere with a +10C offset\natm = ISA1975(T_offset=10)\n\n# Query the ambient density in this model at 41,000 feet \n# noinspection PyTypeChecker\nprint(f\"{atm} density at 41,000 feet:\",\n atm.rho(altitude=Quantity(41_000, \"ft\")))\n```\n\nYou should see the following output:\n\n ISA1975(+10\u00b0C) density at 41,000 feet: 0.28740209 kg m\u207b\u00b3\n\nYou can learn more about `CARPy`'s capabilities through the exemplary\n[notebooks](./docs/source/).\n\n## \ud83d\udc0d Acknowledgements\n\nThe library was authored by:\n\n- Yaseen Reza\n",
"bugtrack_url": null,
"license": "",
"summary": "Consolidated aircraft recipes in Python.",
"version": "0.0.6.post3",
"project_urls": {
"documentation": "https://pypi.org/project/carpy/",
"homepage": "https://github.com/yaseen157/carpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f76ea6a338b458abc01fd878e2f0e23406a833eca50bf6f46b4e563255c6e48",
"md5": "f52de2c8707f2d38814cd7b60aa153fb",
"sha256": "45aa9a0c1fe4db4afec88c2acd9d4d16ee84ea1ace713f842f8ed4c664d5ea1b"
},
"downloads": -1,
"filename": "carpy-0.0.6.post3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f52de2c8707f2d38814cd7b60aa153fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.5",
"size": 4828425,
"upload_time": "2023-11-25T15:56:25",
"upload_time_iso_8601": "2023-11-25T15:56:25.719116Z",
"url": "https://files.pythonhosted.org/packages/1f/76/ea6a338b458abc01fd878e2f0e23406a833eca50bf6f46b4e563255c6e48/carpy-0.0.6.post3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99d02715f71ff2addd18516b80da9e6cd0d4547d76afcfe6faa389f0bc74ad9e",
"md5": "8e0cbbfbc8cce92299abca4584c44743",
"sha256": "dbb2a451c6e9d1c05a69abf8e00e77196144ff0e770c35181562503dd81d1b32"
},
"downloads": -1,
"filename": "carpy-0.0.6.post3.tar.gz",
"has_sig": false,
"md5_digest": "8e0cbbfbc8cce92299abca4584c44743",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.5",
"size": 6646024,
"upload_time": "2023-11-25T15:56:27",
"upload_time_iso_8601": "2023-11-25T15:56:27.520063Z",
"url": "https://files.pythonhosted.org/packages/99/d0/2715f71ff2addd18516b80da9e6cd0d4547d76afcfe6faa389f0bc74ad9e/carpy-0.0.6.post3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 15:56:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yaseen157",
"github_project": "carpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"requirements": [
{
"name": "setuptools",
"specs": [
[
">=",
"67.0.0"
]
]
},
{
"name": "fsspec",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "periodictable",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "python-metar",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "sectionproperties",
"specs": []
},
{
"name": "sympy",
"specs": []
},
{
"name": "jupyter",
"specs": []
},
{
"name": "notebook",
"specs": []
}
],
"lcname": "carpy"
}
JSON
