Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 8, 2024
0 parents commit 8c205ae
Show file tree
Hide file tree
Showing 122 changed files with 52,019 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: eeaa113d258416acea0dda7e840fecb6
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/about/index.doctree
Binary file not shown.
Binary file added .doctrees/cite/index.doctree
Binary file not shown.
Binary file added .doctrees/community/index.doctree
Binary file not shown.
Binary file added .doctrees/contact/index.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/install/index.doctree
Binary file not shown.
Binary file added .doctrees/learn/index.doctree
Binary file not shown.
Binary file added .doctrees/support/index.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
www.fatiando.org
154 changes: 154 additions & 0 deletions _sources/about/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
# About

<div class="lead">
<em>Fatiando a Terra</em> is a collection of <strong>open-source Python
packages</strong> aimed primarily at Geophysics (though not exclusively).
This page contains some information about the project and its history.
</div>

```{admonition} Trivia
*Fatiando a Terra* is Portuguese for *Slicing the Earth*, a reference to the
project's Brazilian origins and ambitious initial goals to model the whole
planet.
```

## Brief history

The Fatiando a Terra project had it's start around 2008 as a C++ program to
perform geophysical modeling of various data types (gravity, magnetics,
seismic, etc.).
At least that was what a
{ref}`small group of Geophysics undergraduate students <founders>` at the
[University of São Paulo][usp], Brazil, set out to do.
Unsurprisingly, this overly ambitious goal was never achieved.

<div class="row text-muted align-items-center fs-6">
<div class="col-md-9">

<img src="../_static/fatiando-as-a-gravmag-gui.svg" alt="Box diagram of the layout and flow of information planned for the GUI program." >

</div>
<div class="col-md-3">

First diagram (in Portuguese) of the planned graphical user interface (GUI) for
the Fatiando C++ program.
Retrieved from commit [<i class="fab fa-github"></i> 10c8ff7][commit-gui]
from 11 February 2009.

</div>
</div>

In 2010, we started developing the [`fatiando`][gh-fatiando]
Python library, which included several state-of-the-art methods for forward
modeling and inversion of gravity and magnetic data, as well as toy problems in
other fields useful for teaching.
Development of this library was discontinued in 2018 as our focus shifted to
our newer and more well-scoped libraries.
This [blog post announcing the shift][blog-fatiando-future] explains the
reasoning behind this decision.

```{note}
The last version that was released of `fatiando` is [v0.5][v0.5-doi].
The documentation for it can still be accessed at
[legacy.fatiando.org](https://legacy.fatiando.org)
```

<div class="row text-muted align-items-center fs-6">
<div class="col-md-9">

<!-- Thumbnail of Youtube video -->
<div class="ratio ratio-16x9">
<div class="yt" style='background-image: url("/_static/fatiando-talks.jpg")'>
<a
href="https://www.youtube.com/watch?v=z-5dvWfB_SM&list=PLPA_RM8wsOqLQRajw_e9ByUe56z7TETaL"
aria-label="Watch on YouTube"
target="_blank"
rel="noopener noreferrer"
>
<div class="play-button">
<img src="/_static/play.svg">
</div>
</a>
<a
href="https://www.youtube.com/watch?v=z-5dvWfB_SM&list=PLPA_RM8wsOqLQRajw_e9ByUe56z7TETaL"
aria-label="Watch on YouTube"
target="_blank"
rel="noopener noreferrer"
>
<div class="watch-on-yt">
<div aria-hidden="true">Watch on</div>
<div><img src="/_static/yt-logo.svg" alt="YouTube logo"></div>
</div>
</a>
</div>
</div>

</div>

<div class="col-md-3">

Our [YouTube channel][youtube] has a [playlist of talks][yt-playlist] given
about Fatiando over the years.

</div>
</div>

## The geophysics Python ecosystem

Fatiando is a part of the larger geophysics open-source Python ecosystem,
which has grown tremendously since we started development in 2010.

<div class="row gy-4 py-3 align-items-center">
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://simpeg.xyz/">
<img src="../_static/simpeg-logo.png" title="SimPEG">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://www.gempy.org/">
<img src="../_static/gempy-logo.png" title="GemPy">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://emsig.xyz/">
<img src="../_static/emsig-logo.svg" title="emsig">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://docs.pyvista.org/">
<img src="../_static/pyvista-logo.png" title="PyVista">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://www.pygimli.org/">
<img src="../_static/pygimli-logo.svg" title="pyGIMLi">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://softwareunderground.github.io/subsurface/">
<img src="../_static/subsurface-logo.svg" title="subsurface">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<a target="_blank" href="https://www.pygmt.org/">
<img src="../_static/pygmt-logo.svg" title="PyGMT">
</a>
</div>
<div class="col-6 col-sm-4 col-md-3">
<img src="../_static/fatiando-banner-small.svg" title="Fatiando a Terra">
</div>
</div>

[youtube]: https://www.youtube.com/fatiandoorg
[yt-playlist]: https://youtube.com/playlist?list=PLPA_RM8wsOqLQRajw_e9ByUe56z7TETaL
[gh]: https://github.com/fatiando
[gh-fatiando]: https://github.com/fatiando/fatiando
[usp]: https://www.iag.usp.br/
[commit-gui]: https://github.com/fatiando/fatiando/blob/10c8ff7c17df53e3e0abd83f1ce8d2a3f6bc57aa/fluxo-simples.pdf
[pinga]: https://www.pinga-lab.org/
[v0.5-doi]: https://doi.org/10.5281/zenodo.157746
[blog-fatiando-future]: https://www.leouieda.com/blog/future-of-fatiando.html
[liv]: https://www.liverpool.ac.uk/earth-ocean-and-ecological-sciences/
[uerj]: https://www.uerj.br/
[conicet]: https://www.conicet.gov.ar/
[capes]: https://www.gov.br/capes
72 changes: 72 additions & 0 deletions _sources/cite/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
(cite)=
# Citing Fatiando

<p class="lead">
If you use our software, please consider citing it in your publications.
Our software is <strong>made by scientists and volunteers</strong> who
generously donate their time and attention.
<strong>Citations</strong> help us justify the effort that goes into building
and maintaining this project.
</p>

## Citing the libraries

Each of our libraries has a `CITATION.rst` file that describes the best way
to cite it in publications:

<div class="mt-2">

<a target="_blank" href="https://github.com/fatiando/pooch/blob/master/CITATION.rst">
<button type="button" class="btn btn-secondary mb-3 me-3">
<i class="fa fa-bookmark"></i>
Pooch
</button></a>

<a target="_blank" href="https://github.com/fatiando/verde/blob/master/CITATION.rst">
<button type="button" class="btn btn-secondary mb-3 me-3">
<i class="fa fa-bookmark"></i>
Verde
</button></a>

<a target="_blank" href="https://github.com/fatiando/harmonica/blob/master/CITATION.rst">
<button type="button" class="btn btn-secondary mb-3 me-3">
<i class="fa fa-bookmark"></i>
Harmonica
</button></a>

<a target="_blank" href="https://github.com/fatiando/boule/blob/master/CITATION.rst">
<button type="button" class="btn btn-secondary mb-3">
<i class="fa fa-bookmark"></i>
Boule
</button></a>

</div>

## Citing the Fatiando project

If you wish to reference the Fatiando project as a whole, please use the
following reference:

> 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. doi:[10.25080/Majora-8b375195-010](https://doi.org/10.25080/Majora-8b375195-010)

This article was [peer-reviewed](https://github.com/scipy-conference/scipy_proceedings/pull/52)
and is open-access.
Source files and extra material for the paper are on the
[`leouieda/scipy2013`](https://github.com/leouieda/scipy2013) GitHub
repository.

Here is a BibTex entry for LaTeX users:

```
@InProceedings{ uieda-proc-scipy-2013,
author = { {L}eonardo {U}ieda and {V}anderlei {C}. {O}liveira {J}r and {V}al\'eria {C}. {F}. {B}arbosa },
title = { {M}odeling the {E}arth with {F}atiando a {T}erra },
booktitle = { {P}roceedings of the 12th {P}ython in {S}cience {C}onference },
pages = { 92 - 98 },
year = { 2013 },
editor = { {S}t\'efan van der {W}alt and {J}arrod {M}illman and {K}aty {H}uff },
doi = { 10.25080/Majora-8b375195-010 }
}
```
121 changes: 121 additions & 0 deletions _sources/community/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
(community)=
# Community

<p class="lead">
Fatiando is a <strong>community-developed</strong> project. It's people
like you who make it useful and successful!
Our tools are developed by <strong>working geoscientists and community
volunteers</strong> from across the globe.
</p>

## <i class="fa fa-comments"></i> Participate

Open-source is more than just code, **it's about the people** involved.
The most important thing you can do for any project is **participate in the
community**: ask and answer questions, share your experience, help guide the
development, and make friends along the way.

The Fatiando community gathers in a few different places online, all of which
are **open to everyone**.
So come along and join the conversation!
See {ref}`contact` to find out where we gather.

<div class="row text-muted align-items-center fs-6">
<div class="col-md-9">
<img class="mb-3" src="../_static/fatiando-community-call.png" title="Screenshot from a virtual Fatiando weekly call.">
</div>
<div class="col-md-3">

Happy community members at one of our [weekly Fatiando calls](contact).

</div>
</div>

Why participate in an open-source project like Fatiando?
There is much for you to gain from your participation:

<ul class="fa-ul">
<li><i class="fa-li fa fa-users fa-fw"></i> Connect with a welcoming global community.</li>
<li><i class="fa-li fa fa-copy fa-fw"></i> Authorship on publications about our software.</li>
<li><i class="fa-li fa fa-graduation-cap fa-fw"></i> Learn first-hand about software engineering.</li>
<li><i class="fa-li fa fa-people-carry fa-fw"></i> Solve your own problems while benefiting the community.</li>
</ul>

There are many ways that you can contribute, including
submitting bug reports and feature requests,
writing tutorials and examples,
fixing typos and improving to the documentation,
and writing code for everyone to use.

```{admonition} Interested?
Have a look at our [Contributing Guide][contrib] to see how you can get
involved.
This and other guides (authorship policy, project maintenance, etc.) can be
found in the [<i class="fab fa-github"></i> `fatiando/community`][community-repo]
repository.
```

```{important}
Everyone is required to abide by our [Code of Conduct][coc] when participating
in the Fatiando community. Please review it carefully.
```

## <i class="fa fa-users"></i> Who we are

The organization structure of Fatiando is outlined in our [Governance
document][governance]. It specifies the existing roles within our community,
what are the responsibilities assigned to each one, and how to gain
responsibilities within our organization.
Below is a list of the people currently occupying each role.

### Steering Council

The overall role of the Steering Council is to ensure the long-term well-being of the
project. It is composed
of community members who have distinguished themselves by making substantial
contributions to the project over time.

```{fatiando-governance} community/steering-council.json
```

```{admonition} Benevolent Dictator For Life (BDFL)
The BDFL is chair of the Steering Council and has the same responsibilities of
other Council members.
As *Dictator*, they also have the authority to make all final decisions for the
project.
As *Benevolent*, they, in practice, chooses to defer that authority to the
consensus of the Community and Steering Council.
```

(founders)=
### Project Founders

The Founders are the people who played a role in the conceptualization of
Fatiando. They hold no special authority and are included as an acknowledgement
of their initial contribution.

```{fatiando-governance} community/founders.json
```

### Package Authors

The [GitHub repositories][gh] for each project contain `AUTHORS.md` files which
list everyone involved.
These are the people listed in those files.

```{note}
Our [Authorship Guidelines][authorship] define the rules for attributing
authorship to those involved in our projects.
```

```{fatiando-authors} harmonica,verde,boule,pooch,ensaio,choclo
```


[coc]: https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md
[contrib]: https://github.com/fatiando/community/blob/main/CONTRIBUTING.md
[governance]: https://github.com/fatiando/community/blob/main/GOVERNANCE.md
[community-repo]: https://github.com/fatiando/community
[gh]: https://github.com/fatiando
[notes]: https://github.com/fatiando/community
[authorship]: https://github.com/fatiando/community/blob/main/AUTHORSHIP.md
Loading

0 comments on commit 8c205ae

Please sign in to comment.