.. title:: Home .. grid:: :gutter: 2 3 3 3 :margin: 5 5 0 0 :padding: 0 0 0 0 .. grid-item:: :columns: 12 8 8 8 .. raw:: html

Boule

.. div:: sd-fs-3 Reference ellipsoids for geodesy and geophysics .. grid-item:: :columns: 12 4 4 4 .. image:: ./_static/boule-logo.svg :width: 200px :class: sd-m-auto **Boule** is Python library for representing :term:`reference ellipsoids ` geometrically, calculating their gravity fields, and performing some global coordinate conversions. "Boule" is also French for "ball" as well as a `traditional shape of bread resembling a squashed ball `__ (much like the Earth). Boule is designed for: * Storing and manipulating ellipsoid parameters for spherical harmonic analysis and coordinate system conversions. * Calculating :term:`normal gravity` for generating gravity anomalies and :term:`gravity disturbances `. ---- .. grid:: 1 2 1 2 :margin: 5 5 0 0 :padding: 0 0 0 0 :gutter: 4 .. grid-item-card:: :octicon:`info` Getting started :text-align: center :class-title: sd-fs-5 :class-card: sd-p-3 New to Boule? Start here! .. button-ref:: overview :ref-type: ref :click-parent: :color: primary :outline: :expand: .. grid-item-card:: :octicon:`comment-discussion` Need help? :text-align: center :class-title: sd-fs-5 :class-card: sd-p-3 Ask on our community channels. .. button-link:: https://www.fatiando.org/contact :click-parent: :color: primary :outline: :expand: Join the conversation :octicon:`link-external` .. grid-item-card:: :octicon:`file-badge` Reference documentation :text-align: center :class-title: sd-fs-5 :class-card: sd-p-3 A list of modules and functions. .. button-ref:: api :ref-type: ref :color: primary :outline: :expand: .. grid-item-card:: :octicon:`bookmark` Using Boule for research? :text-align: center :class-title: sd-fs-5 :class-card: sd-p-3 Citations help support our work! .. button-ref:: citing :ref-type: ref :color: primary :outline: :expand: ---- .. admonition:: Boule is ready for use but still changing :class: important This means that we sometimes break backwards compatibility as we try to improve the software based on user experience, new ideas, better design decisions, etc. Please keep that in mind before you update Boule to a newer version. :octicon:`code-review` **We welcome feedback and ideas!** This is a great time to bring new ideas on how we can improve the project. `Join the conversation `__ or submit `issues on GitHub `__. .. seealso:: Boule is a part of the `Fatiando a Terra `_ project. .. toctree:: :maxdepth: 2 :hidden: :caption: Getting Started overview.rst install.rst .. toctree:: :maxdepth: 2 :hidden: :caption: User Guide user_guide/normal_gravity.rst user_guide/gravity_disturbance.rst user_guide/coordinates.rst user_guide/defining_ellipsoids.rst .. toctree:: :maxdepth: 2 :hidden: :caption: Reference Documentation api/index.rst ellipsoids.rst citing.rst glossary.rst references.rst changes.rst compatibility.rst versions.rst .. toctree:: :maxdepth: 2 :hidden: :caption: Community Join the community How to contribute Code of Conduct Source code on GitHub The Fatiando a Terra project