.. image:: https://img.shields.io/pypi/v/ambiance.svg?style=flat :target: https://pypi.org/project/ambiance/ :alt: Latest PyPI version
.. image:: https://readthedocs.org/projects/ambiance/badge/?version=latest :target: https://ambiance.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg :target: https://github.com/airinnova/ambiance/blob/master/LICENSE.txt :alt: License
.. image:: https://app.travis-ci.com/airinnova/ambiance.svg?branch=master :target: https://app.travis-ci.com/airinnova/ambiance :alt: Build status
.. image:: https://codecov.io/gh/airinnova/ambiance/branch/master/graph/badge.svg :target: https://codecov.io/gh/airinnova/ambiance :alt: Coverage
|
.. image:: https://raw.githubusercontent.com/airinnova/ambiance/master/docs/source/_static/images/logo/logo.png :target: https://github.com/airinnova/ambiance/ :alt: Ambiance
Ambiance is a full implementation of the ICAO standard atmosphere 1993 written in Python.
International Standard Atmosphere (Wikipedia) <https://en.wikipedia.org/wiki/International_Standard_Atmosphere>_Atmospheric properties are computed from an Atmosphere object which takes the altitude (geometric height) as input. For instance, to simply retrieve sea level properties, you can write:
.. code:: python
>>> from ambiance import Atmosphere
>>> sealevel = Atmosphere(0)
>>> sealevel.temperature
array([288.15])
>>> sealevel.pressure
array([101325.])
>>> sealevel.kinematic_viscosity
array([1.46071857e-05])
collision_frequency)density)dynamic_viscosity)MSL <https://en.wikipedia.org/wiki/Sea_level>_ (h)H)grav_accel)kinematic_viscosity)layer_name) [string array]mean_free_path)mean_particle_speed)number_density)pressure)pressure_scale_height)specific_weight)speed_of_sound)temperature, temperature_in_celsius)thermal_conductivity)Ambiance also handles list-like input (list, tuples, Numpy arrays). The following code demonstrates how to produce a temperature plot with Matplotlib. In the example, Numpy's linspace() function is used to produce an array with altitudes.
.. code:: python
import numpy as np
import matplotlib.pyplot as plt
from ambiance import Atmosphere
# Create an atmosphere object
heights = np.linspace(-5e3, 80e3, num=1000)
atmosphere = Atmosphere(heights)
# Make plot
plt.plot(atmosphere.temperature_in_celsius, heights/1000)
plt.ylabel('Height [km]')
plt.xlabel('Temperature [°C]')
plt.grid()
plt.show()
The output is
.. image:: https://raw.githubusercontent.com/airinnova/ambiance/master/tests/plots/temperature.png :alt: Temperature plot
Similarly, you can also pass in entire matrices. Example:
.. code:: python
>>> import numpy as np
>>> from ambiance import Atmosphere
>>> h = np.array([[0, 11, 12], [20, 21, 35], [0, 80, 50]])*1000
>>> h # Geometric heights in metres
array([[ 0, 11000, 12000],
[20000, 21000, 35000],
[ 0, 80000, 50000]])
>>> Atmosphere(h).temperature
array([[288.15 , 216.7735127 , 216.65 ],
[216.65 , 217.58085353, 236.51337209],
[288.15 , 198.63857625, 270.65 ]])
>>> Atmosphere(h).speed_of_sound
array([[340.29398803, 295.15359145, 295.06949351],
[295.06949351, 295.70270856, 308.29949587],
[340.29398803, 282.53793156, 329.798731 ]])
>>> Atmosphere([30000, 0]).layer_name
array(['stratosphere', 'troposphere'], dtype='<U42')
In some contexts it may be convenient to instantiate an Atmosphere object from a given ambient pressure or density. This can be easily achieved by using the Atmosphere.from_pressure() or Atmosphere.from_density() methods, respectively. Both methods return Atmosphere objects from which all other properties, like temperature, can be requested.
.. code:: python
>>> Atmosphere.from_pressure([80e3, 20e3]) # 80 kPa and 20 kPa
Atmosphere(array([ 1949.58557497, 11805.91571135]))
>>> Atmosphere.from_pressure([80e3, 20e3]).pressure
array([80000., 20000.])
>>> Atmosphere.from_density(1.0) # 1.0 kg/m^3
Atmosphere(array([2064.96635895]))
For a comprehensive and detailed user guide, please see the complete documentation <https://ambiance.readthedocs.io/en/latest/>_.
Ambiance is available on PyPI <https://pypi.org/project/ambiance/>_ and may simply be installed with
.. code::
pip install ambiance
The package can be installed via the Conda <https://anaconda.org/conda-forge/ambiance>_ environment with
.. code::
conda install -c conda-forge ambiance
.. image:: https://img.shields.io/badge/recipe-ambiance-green.svg :target: https://anaconda.org/conda-forge/ambiance :alt: Conda Recipe
.. image:: https://img.shields.io/conda/dn/conda-forge/ambiance.svg :target: https://anaconda.org/conda-forge/ambiance :alt: Conda Downloads
.. image:: https://img.shields.io/conda/vn/conda-forge/ambiance.svg :target: https://anaconda.org/conda-forge/ambiance :alt: Conda Version
Using Ambiance requires
For developers: Recommended packages may be installed with the requirements.txt.
.. code::
pip install -r requirements.txt
License: Apache-2.0
FAQs
A full implementation of the ICAO standard atmosphere 1993
We found that ambiance demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.