Project status

Boule

Reference ellipsoids for geodesy and geophysics

_images/boule-logo.svg

Boule is Python library for representing 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:

See also

Boule is a part of the Fatiando a Terra project.

Getting started

New to Boule? Start here!

Overview

Need help?

Ask on our community channels.

Join the conversation

Reference documentation

A list of modules and functions.

List of functions and classes (API)

Using Boule for research?

Citations help support our work!

Citing Boule


Project status#

Boule is ready for use but still changing. 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.

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.

Getting involved#

🗨️ Contact us: Find out more about how to reach us at fatiando.org/contact.

👩🏾‍💻 Contributing to project development: Please read our Contributing Guide to see how you can help and give feedback.

🤖 Policy on AI usage: Please read our AI Usage Policy.

🧑🏾‍🤝‍🧑🏼 Code of conduct: This project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.

Imposter syndrome disclaimer: We want your help. No, really. There may be a little voice inside your head that is telling you that you’re not ready, that you aren’t skilled enough to contribute. We assure you that the little voice in your head is wrong. Most importantly, there are many valuable ways to contribute besides writing code (giving feedback, teaching, writing documentation, and more).

This disclaimer was adapted from the MetPy project.

License#

This is free software: you can redistribute it and/or modify it under the terms of the BSD 3-clause License. A copy of this license is provided in LICENSE.txt.