diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..bab6502b --- /dev/null +++ b/.buildinfo @@ -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 diff --git a/.doctrees/about/index.doctree b/.doctrees/about/index.doctree new file mode 100644 index 00000000..59c12d7a Binary files /dev/null and b/.doctrees/about/index.doctree differ diff --git a/.doctrees/cite/index.doctree b/.doctrees/cite/index.doctree new file mode 100644 index 00000000..59817088 Binary files /dev/null and b/.doctrees/cite/index.doctree differ diff --git a/.doctrees/community/index.doctree b/.doctrees/community/index.doctree new file mode 100644 index 00000000..67740107 Binary files /dev/null and b/.doctrees/community/index.doctree differ diff --git a/.doctrees/contact/index.doctree b/.doctrees/contact/index.doctree new file mode 100644 index 00000000..20e8c07e Binary files /dev/null and b/.doctrees/contact/index.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 00000000..151fcc57 Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 00000000..156be355 Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.doctrees/install/index.doctree b/.doctrees/install/index.doctree new file mode 100644 index 00000000..0c7cfd12 Binary files /dev/null and b/.doctrees/install/index.doctree differ diff --git a/.doctrees/learn/index.doctree b/.doctrees/learn/index.doctree new file mode 100644 index 00000000..6a34f125 Binary files /dev/null and b/.doctrees/learn/index.doctree differ diff --git a/.doctrees/support/index.doctree b/.doctrees/support/index.doctree new file mode 100644 index 00000000..0de95dcf Binary files /dev/null and b/.doctrees/support/index.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..56140505 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +www.fatiando.org diff --git a/_sources/about/index.md.txt b/_sources/about/index.md.txt new file mode 100644 index 00000000..75c8d4a8 --- /dev/null +++ b/_sources/about/index.md.txt @@ -0,0 +1,154 @@ +# About + +
+If you use our software, please consider citing it in your publications. +Our software is made by scientists and volunteers who +generously donate their time and attention. +Citations help us justify the effort that goes into building +and maintaining this project. +
+ +## Citing the libraries + +Each of our libraries has a `CITATION.rst` file that describes the best way +to cite it in publications: + + + +## 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 } +} +``` diff --git a/_sources/community/index.md.txt b/_sources/community/index.md.txt new file mode 100644 index 00000000..b27fd16d --- /dev/null +++ b/_sources/community/index.md.txt @@ -0,0 +1,121 @@ +(community)= +# Community + ++Fatiando is a community-developed project. It's people +like you who make it useful and successful! +Our tools are developed by working geoscientists and community +volunteers from across the globe. +
+ +## 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. + ++Our project is developed in the open with the help of our community. +Your input is welcome and appreciated. +Get in touch! +
+ ++Running this code multiple times will only result in a single download +because the data are cached where Pooch can find it. +
+ ++This code calculates the gravity acceleration and magnetic field generated by +a single prism on a single observation point. +
+ ++Our tools are built in Python and can be used in Jupyter notebooks, +scripts, and other libraries and programs. All of our software is +compatible with Linux, Mac, and Windows. +
+ +## Getting Python + +In order to start using the Fatiando tools you need to **install a Python +distribution**. +We recommend using [Anaconda][anaconda]. +You can find detailed instructions on how to install it on any operating system +in the [Software Carpentry setup instructions][swc-install]. + +## Install the latest tools + +Once you've finished setting up Python, you can install all of the latest +Fatiando tools. + +The **recommended** method is using the `conda` package manager with a single +command: + +```bash +conda install verde harmonica boule pooch --channel conda-forge +``` + +Alternatively, you can use the `pip` package manager: + +```bash +pip install verde harmonica boule pooch +``` + +```{tip} +Run these commands in a terminal (Linux/Mac) or "Anaconda prompt" (Windows). +``` + +[anaconda]: https://www.anaconda.com/products/individual +[swc-install]: https://carpentries.github.io/workshop-template/#python + +--- + +## Installing the legacy `fatiando` package + +```{warning} +The old `fatiando` package **is not currently maintained or developed**, +meaning that **it won't get bug fixes or new features**. The purpose of these +instructions are for **legacy use only**, in order to run old code to check +reproducibility of results. +``` + +```{tip} +If you are working on some new research or data analysis, we strongly +**recommend using the [latest tools](#install-the-latest-tools)** instead. +``` + +If you need to install the old `fatiando` package, you can still do so through +`conda`. Please note the following instructions were only tested under a GNU/Linux distribution, so +we don't guarantee that they will also work on a different OS. + +Since the old `fatiando` runs on Python 2.7, a deprecated version of Python, +you need to create a separate environment for our installation in order to +avoid conflicts with your Anaconda installation. + +Create a new environment and install the required packages: + +``` +conda create --name fatiando-legacy -c conda-forge python=2.7 numpy=1.10 scipy=1.2 matplotlib=2.2 pillow=6.2 future=0.18 numba=0.43 pytest=4.6 fatiando=0.5 +``` + +Activate the newly created environment: + +```bash +conda activate fatiando-legacy +``` + +And test your installation: + +```bash +python -c "import fatiando; fatiando.test()" +``` + +You should see a green dot after each test is run and no red `F`. + +The documentation for the legacy `fatiando` package is available at +[legacy.fatiando.org](https://legacy.fatiando.org). diff --git a/_sources/learn/index.md.txt b/_sources/learn/index.md.txt new file mode 100644 index 00000000..42639181 --- /dev/null +++ b/_sources/learn/index.md.txt @@ -0,0 +1,217 @@ +(learn)= +# Learn how to use our software + ++Learning how to use Python libraries can be challenging, particularly if you're +new to Python. +Don't worry! +Here are some resources to help you get started. +
+ +## Tutorials + +Our [YouTube channel][youtube] +has video tutorials, demonstrations, and talks about several of the tools +that we develop. + +fatiando
library?
+**It still exists!**
+While development of the `fatiando` library has stopped in favour of our new
+tools, you can still install it and view the documentation for version 0.5 at
+[legacy.fatiando.org](https://legacy.fatiando.org)
+```
+
+## New to Python?
+
+If you don't have much experience with Python, **don't worry!**
+
+[Software Carpentry][swc] provides open-source lessons (also available in
+Spanish) about Python for scientific computing and much more.
+This is a great resource and all they teach is worth learning.
+We recommend starting with these two:
+["Programming with Python"][swc-python]
+and
+["Plotting and Programming in Python"][swc-python2].
+
++Here are some of the ways in which you can help support the project and give +back to the community. +
+ +## Cite our software + +Citations help us justify the effort that goes into building and maintaining +this project. If you use our software, please consider +**{ref}`citing it ` in your publications**. + +## Get involved + +Fatiando only exists because of the efforts of our **community members**, most +of which volunteer their time and energy. +One of the **most impactful ways you can help** is by +{ref}`being involved`s get reset. However, we also reset the\n// bottom margin to use `rem` units instead of `em`.\n\np {\n margin-top: 0;\n margin-bottom: $paragraph-margin-bottom;\n}\n\n\n// Abbreviations\n//\n// 1. Duplicate behavior to the data-bs-* attribute for our tooltip plugin\n// 2. Add the correct text decoration in Chrome, Edge, Opera, and Safari.\n// 3. Add explicit cursor to indicate changed behavior.\n// 4. Prevent the text-decoration to be skipped.\n\nabbr[title],\nabbr[data-bs-original-title] { // 1\n text-decoration: underline dotted; // 2\n cursor: help; // 3\n text-decoration-skip-ink: none; // 4\n}\n\n\n// Address\n\naddress {\n margin-bottom: 1rem;\n font-style: normal;\n line-height: inherit;\n}\n\n\n// Lists\n\nol,\nul {\n padding-left: 2rem;\n}\n\nol,\nul,\ndl {\n margin-top: 0;\n margin-bottom: 1rem;\n}\n\nol ol,\nul ul,\nol ul,\nul ol {\n margin-bottom: 0;\n}\n\ndt {\n font-weight: $dt-font-weight;\n}\n\n// 1. Undo browser default\n\ndd {\n margin-bottom: .5rem;\n margin-left: 0; // 1\n}\n\n\n// Blockquote\n\nblockquote {\n margin: 0 0 1rem;\n}\n\n\n// Strong\n//\n// Add the correct font weight in Chrome, Edge, and Safari\n\nb,\nstrong {\n font-weight: $font-weight-bolder;\n}\n\n\n// Small\n//\n// Add the correct font size in all browsers\n\nsmall {\n @include font-size($small-font-size);\n}\n\n\n// Mark\n\nmark {\n padding: $mark-padding;\n background-color: $mark-bg;\n}\n\n\n// Sub and Sup\n//\n// Prevent `sub` and `sup` elements from affecting the line height in\n// all browsers.\n\nsub,\nsup {\n position: relative;\n @include font-size($sub-sup-font-size);\n line-height: 0;\n vertical-align: baseline;\n}\n\nsub { bottom: -.25em; }\nsup { top: -.5em; }\n\n\n// Links\n\na {\n color: $link-color;\n text-decoration: $link-decoration;\n\n &:hover {\n color: $link-hover-color;\n text-decoration: $link-hover-decoration;\n }\n}\n\n// And undo these styles for placeholder links/named anchors (without href).\n// It would be more straightforward to just use a[href] in previous block, but that\n// causes specificity issues in many other styles that are too complex to fix.\n// See https://github.com/twbs/bootstrap/issues/19402\n\na:not([href]):not([class]) {\n &,\n &:hover {\n color: inherit;\n text-decoration: none;\n }\n}\n\n\n// Code\n\npre,\ncode,\nkbd,\nsamp {\n font-family: $font-family-code;\n @include font-size(1em); // Correct the odd `em` font sizing in all browsers.\n direction: ltr #{\"/* rtl:ignore */\"};\n unicode-bidi: bidi-override;\n}\n\n// 1. Remove browser default top margin\n// 2. Reset browser default of `1em` to use `rem`s\n// 3. Don't allow content to break outside\n\npre {\n display: block;\n margin-top: 0; // 1\n margin-bottom: 1rem; // 2\n overflow: auto; // 3\n @include font-size($code-font-size);\n color: $pre-color;\n\n // Account for some code outputs that place code tags in pre tags\n code {\n @include font-size(inherit);\n color: inherit;\n word-break: normal;\n }\n}\n\ncode {\n @include font-size($code-font-size);\n color: $code-color;\n word-wrap: break-word;\n\n // Streamline the style when inside anchors to avoid broken underline and more\n a > & {\n color: inherit;\n }\n}\n\nkbd {\n padding: $kbd-padding-y $kbd-padding-x;\n @include font-size($kbd-font-size);\n color: $kbd-color;\n background-color: $kbd-bg;\n @include border-radius($border-radius-sm);\n\n kbd {\n padding: 0;\n @include font-size(1em);\n font-weight: $nested-kbd-font-weight;\n }\n}\n\n\n// Figures\n//\n// Apply a consistent margin strategy (matches our type styles).\n\nfigure {\n margin: 0 0 1rem;\n}\n\n\n// Images and content\n\nimg,\nsvg {\n vertical-align: middle;\n}\n\n\n// Tables\n//\n// Prevent double borders\n\ntable {\n caption-side: bottom;\n border-collapse: collapse;\n}\n\ncaption {\n padding-top: $table-cell-padding-y;\n padding-bottom: $table-cell-padding-y;\n color: $table-caption-color;\n text-align: left;\n}\n\n// 1. Removes font-weight bold by inheriting\n// 2. Matches default `