A Python package for calculating fuel burn of commercial aircraft.
Maintainance Team: @michaelweinold
See the package documentation for installation instructions.
The package documentation is based on mkdocs. To build the documentation locally, install required packages from the docs/_requirements.txt file and navigate to the package root directory to execute:
mkdocs servePackage tests are based on pytest. To run all tests, navigate to the package root directory and execute:
pytestWhen developing with Visual Studio Code, test can also be run from the Test Explorer sidebar.
The package uses GitHub Actions for continuous integration and deployment. The CI/CD pipeline is defined in the .github/workflows directory.
| Workflow | Description | Trigger |
|---|---|---|
.github/workflows/test_package.yml |
Runs all tests. | Every new pull request and push to the main branch. |
.github/workflows/publish_testpypi.yml |
Runs all tests and uploads the package to TestPyPI. | Every new version tag. |
.github/workflows/publish_pypi.yml |
Runs all tests and uploads the package to PyPI. | Every new version release. |