fatiando / Fatiando

.. image:: https://raw.githubusercontent.com/fatiando/logo/master/fatiando-banner-homepage.png :alt: Fatiando a Terra :target: http://www.fatiando.org

Website <http://www.fatiando.org>__ | Documentation <http://www.fatiando.org/docs>__ | Gallery <http://www.fatiando.org/gallery/>__ | Docs (development version) <http://www.fatiando.org/dev>__ | Mailing list <https://groups.google.com/d/forum/fatiando>__

.. image:: http://img.shields.io/pypi/v/fatiando.svg?style=flat-square :alt: Latest version on PyPI :target: https://pypi.python.org/pypi/fatiando/ .. image:: http://img.shields.io/travis/fatiando/fatiando/master.svg?style=flat-square&label=linux :alt: Travis CI build status :target: https://travis-ci.org/fatiando/fatiando .. image:: https://img.shields.io/appveyor/ci/leouieda/fatiando/master.svg?style=flat-square&label=windows :alt: AppVeyor build status :target: https://ci.appveyor.com/project/leouieda/fatiando .. image:: http://img.shields.io/coveralls/fatiando/fatiando/master.svg?style=flat-square :alt: Test coverage status :target: https://coveralls.io/r/fatiando/fatiando?branch=master .. image:: https://landscape.io/github/fatiando/fatiando/master/landscape.svg?style=flat-square :target: https://landscape.io/github/fatiando/fatiando/master :alt: Code health report by landscape.io .. image:: http://img.shields.io/badge/doi-10.5281/zenodo.157746-blue.svg?style=flat-square :alt: doi:10.5281/zenodo.157746 :target: http://dx.doi.org/10.5281/zenodo.157746

Disclaimer

Fatiando is under active development and we are still changing the API between releases. Names will change and functions will move as we improve our design. You might have to update your scripts and notebooks to get the latest features from a new release.

Please bear with us.

Overview

Our goal is provide a comprehensive and extensible framework for geophysical data analysis and the development of new methodologies.

Research: Make your research more reproducible by writing a Python script or Jupyter notebook instead of clicking through complicated menus.

Development: Don't start from scratch! Build upon the existing tools in Fatiando to develop new methods.

Teaching: Combine Fatiando with the Jupyter notebook to make rich, interactive documents. Great for teaching fundamental concepts of geophysics!

Getting started

1. Install Fatiando <http://www.fatiando.org/install.html>__ and its dependencies.
2. Browse the Gallery <http://www.fatiando.org/gallery/index.html>__ for examples of what Fatiando can do.
3. Take a look at the rest of the Documentation <http://www.fatiando.org/docs.html>__ for more information about the library.
4. Get involved in the community and see how you can help in our Contributor Guide <http://www.fatiando.org/develop.html>__.

Contributing and asking for help

Subscribe to our Google Groups mailing list to stay informed and ask for help: groups.google.com/d/forum/fatiando <https://groups.google.com/d/forum/fatiando>__

We'll post updates to the list about new releases and features, events, and future plans for the project. Get involved to help us shape the project and make it even better!

Another option for reaching out and reporting bugs is to open an issue on Github <https://github.com/fatiando/fatiando/issues>__.

We have an open development process where everything is discussed through Github issues <https://github.com/fatiando/fatiando/issues>. Anyone can comment and give feedback. See our Roadmap for v1.0 <https://github.com/fatiando/fatiando/issues/102> to get a feeling for where the project is headed. Your input is welcome!

Supporting

If you use Fatiando in your research, please cite it in your publications as:

Uieda, L., V. C. Oliveira Jr, and V. C. F. Barbosa (2013), Modeling the
Earth with Fatiando a Terra, Proceedings of the 12th Python in Science
Conference, pp. 91 - 98.

Please also cite the method papers of individual functions/classes. References are available in the documentation of each module/function/class.

See the CITATION.rst <https://github.com/fatiando/fatiando/blob/master/CITATION.rst>__ file or the Citing section <http://www.fatiando.org/cite.html>__ of the docs for more information.

You can also show your support by buying a sticker from Stickermule <https://www.stickermule.com/marketplace/16580-fatiando-a-terra>__. We don't make any money from the sales but it helps spread the word about the project.

License

Fatiando a Terra 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.