Skip to content

Commit

Permalink
Merge branch 'docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
Jorge Martínez committed Jul 26, 2020
2 parents a13ff89 + 9ac44f1 commit ed406e5
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 13 deletions.
37 changes: 37 additions & 0 deletions docs/source/about.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
About atmopy library
====================

Why atmospheric modelling
-------------------------

Air drag plays a big role when it comes to aircraft performance or spacecraft
orbital decay. Since this force is proportional to air density, several models
have tried all along history to model the Earth's atmosphere to achieve high
accurate results. They might consider the air to be static, different solar
conditions such us day and night and many other variables.

But atmospheric modelling does not only play a big role in our planet. It is
possible to find other celestial bodies in the Solar System such us Venus, who
has a very dense and hot atmosphere, or Jupiter moons. Those models, although
more difficult to generate because of lack of data compared to Earth one, are
important when it comes to spacecraft landing or any other maneuver in which
drag is not negligible.


Old models: software archaeology
--------------------------------

It is quite difficult to understand latest atmospheric mathematical models
without having a look at all previous developed models. You should be aware that
atmospheric modelling started together with the development of the first
rockets and missiles. Data registers from sensors located in those machines,
enable to generate different mathematical approaches.

Therefore, the reasons behind old models implemented within **atmopy** are not
because they are useful, but for historical reasons. One of the objectives is
also to create some kind of software atmospheric library, not only hosting
source code but also original papers.

Finally, having a collection of models implemented in Python improves
readability a lot. Some of them were initially implemented in Fortran or C/C++,
programming languages which can be a little bit confusing for amateur users.
28 changes: 15 additions & 13 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
.. atmopy documentation master file, created by
sphinx-quickstart on Sun May 3 18:00:49 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to atmopy's documentation!
===========================================================
==================================

.. image:: _static/logo.png
:align: center

This is the official web hosted documentation for the **atmopy** Python library
who's main purpose is to provide easy atmospheric computations for different
atmospheric models.


.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Welcome to atmopy

about

.. toctree::
:maxdepth: 2
:caption: Explanations

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
models/diehl22

0 comments on commit ed406e5

Please sign in to comment.