-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jorge Martínez
committed
Jul 16, 2020
0 parents
commit 3163226
Showing
27 changed files
with
603 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
|
||
# Created by https://www.gitignore.io/api/python | ||
# Edit at https://www.gitignore.io/?templates=python | ||
|
||
### Python ### | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
pip-wheel-metadata/ | ||
share/python-wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
MANIFEST | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.nox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# pipenv | ||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. | ||
# However, in case of collaboration, if having platform-specific dependencies or dependencies | ||
# having no cross-platform support, pipenv may install dependencies that don't work, or not | ||
# install all needed dependencies. | ||
#Pipfile.lock | ||
|
||
# celery beat schedule file | ||
celerybeat-schedule | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# Mr Developer | ||
.mr.developer.cfg | ||
.project | ||
.pydevproject | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# End of https://www.gitignore.io/api/python |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# https://black.readthedocs.io/en/stable/the_black_code_style.html#how-black-wraps-lines | ||
[settings] | ||
multi_line_output=3 | ||
include_trailing_comma=True | ||
force_grid_wrap=0 | ||
use_parentheses=True | ||
line_length=88 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
version: 2 | ||
python: | ||
install: | ||
- method: pip | ||
path: . | ||
extra_requirements: | ||
- doc | ||
sphinx: | ||
fail_on_warning: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
language: python | ||
dist: xenial | ||
matrix: | ||
include: | ||
- python: 3.7 | ||
env: TOXENV=check | ||
- python: 3.7 | ||
env: TOXENV=coverage | ||
- python: 3.7 | ||
env: TOXENV=py37 | ||
- python: 3.8 | ||
env: TOXENV=py38 | ||
install: | ||
- pip install tox | ||
- pip install codecov | ||
script: | ||
tox -e $TOXENV | ||
after_success: | ||
- codecov |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
Contributor Covenant Code of Conduct | ||
==================================== | ||
|
||
|
||
Our Pledge | ||
---------- | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
|
||
Our Standards | ||
------------- | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances. | ||
* Trolling, insulting/derogatory comments, and personal or political attacks. | ||
* Public or private harassment. | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission. | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting. | ||
|
||
|
||
Our Responsibilities | ||
-------------------- | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, or to ban temporarily or permanently any | ||
contributor for other behaviors that they deem inappropriate, threatening, | ||
offensive, or harmful. | ||
|
||
|
||
Scope | ||
----- | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
|
||
Enforcement | ||
----------- | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at jorge@on-orbit.dev. All complaints | ||
will be reviewed and investigated and will result in a response that is deemed | ||
necessary and appropriate to the circumstances. The project team is obligated to | ||
maintain confidentiality with regard to the reporter of an incident. Further | ||
details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
|
||
Attribution | ||
----------- | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 1.4, available at | ||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
Contributing guidelines | ||
======================= | ||
|
||
Before contributing | ||
------------------- | ||
|
||
Welcome to atmopy! Before contributing to the project, | ||
make sure that you **read our code of conduct** (`CODE_OF_CONDUCT.md`). | ||
|
||
|
||
Contributing code | ||
----------------- | ||
|
||
1. Set up a Python development environment | ||
(advice: use [venv](https://docs.python.org/y/library/venv.html), | ||
[virtualenv](https://virtualenv.pypa.io/), or [miniconda](https://docs.conda.io/en/latest/miniconda.html)) | ||
2. Install tox: `python -m pip install tox` | ||
3. Clone the repository | ||
4. Start a new branch off master: `git switch -c new-branch master` | ||
5. Make your code changes | ||
6. Check that your code follows the style guidelines of the project: `tox -e reformat && tox -e check` | ||
7. Run the tests: `tox` | ||
(change the version number according to the Python you are using) | ||
8. Commit, push, and open a pull request! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2012-2019 Juan Luis Cano Rodríguez and the poliastro development team | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
<p align="center"> | ||
<img src="docs/source/_static/logo.png"> | ||
</p> | ||
<p align="center"> | ||
<a href="https://github.com/jorgepiloto/atmopy" alt="atmopy"> | ||
<img src="https://img.shields.io/badge/-atmopy%20%F0%9F%8C%8D-blue"/> | ||
</a> | ||
<a href="https://www.python.org" alt="python"> | ||
<img src="https://img.shields.io/badge/Made%20with-Python-1f425f.svg"/> | ||
</a> | ||
<a href="https://github.com/jorgepiloto/amtmopy" alt="license"> | ||
<img src="https://img.shields.io/github/license/jorgepiloto/atmopy"/> | ||
</a> | ||
<a href="https://travis-ci.com/jorgepiloto/atmopy" alt="travis"> | ||
<img src="https://travis-ci.com/jorgepiloto/atmopy.svg?branch=master"/> | ||
</a> | ||
<a href="https://codecov.io/github/jorgepiloto/atmopy?branch=master" alt="codecov"> | ||
<img src="https://img.shields.io/codecov/c/github/jorgepiloto/atmopy.svg"/> | ||
</a> | ||
</p> | ||
|
||
|
||
About | ||
----- | ||
|
||
Modelling the atmosphere is a complicated task since many variables play a role | ||
on the different thermodynamic conditions: solar-fluxes, latitude and longitude | ||
position, diffusion of the different gasses... | ||
|
||
Since the early days of aviation and astronautics, scientists have tried to | ||
develop different models which take into account all the previous parameters in | ||
order to get the most accurate results. In particular, we care about density | ||
since it is directly related to drag force and therefore with orbital decay | ||
among time. | ||
|
||
This package is not only a collection of atmospheric routines but also a tribute | ||
to all those people who developed them during the early days of astronautics. | ||
|
||
|
||
How to contribute | ||
----------------- | ||
|
||
All contributors al welcome! As developer, you will need to clone the repository | ||
in your local machine and install it in "dev" mode, so as soon as you modify | ||
anything on the source code, your changes will show in the behaviour of the | ||
package. Please, follow these steps in order to achieve previous objective: | ||
|
||
1. Clone this repository. | ||
2. Run `flit install --symlink` so a symbolic link is created to the package. | ||
3. Create a new branch, push changes and open a pull request to merge into | ||
master. | ||
|
||
|
||
Coding guides | ||
------------- | ||
|
||
Every time you enter a new project, you enter a new world. Each project holds | ||
its own coding rules and all your contributions need to agree with them. | ||
Usually, coding rules are justified because of the nature of the project, as it | ||
happens in this case: | ||
|
||
1. All atmosphere models should hold original physical constants and quantities, | ||
no matter if they are outdated. The idea is to get a model as close to the | ||
original one. | ||
|
||
2. Models should be implemented under the same sub-package making, if necessary, | ||
a separation between model constants and logical routines. | ||
|
||
Regarding coding line lengths, string definitions, imports order and so on, the | ||
tool tox is provided for developers. By simply running `tox -e reformat` your | ||
code will be properly adapted to the project standards. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line, and also | ||
# from the environment for the first two. | ||
SPHINXOPTS ?= | ||
SPHINXBUILD ?= sphinx-build | ||
SOURCEDIR = source | ||
BUILDDIR = build | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
Empty file.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.