Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and create a proper user guide #305

Merged
merged 47 commits into from
Jun 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
c22655f
Update Harmonica description on README.rst
santisoler Apr 5, 2022
dab6aad
Add sphinx-panels as requirement for building docs
santisoler Apr 5, 2022
7457a21
Hide home page from the TOC
santisoler Apr 5, 2022
de050d3
Minor changes in Sphinx configuration
santisoler Apr 5, 2022
415e5be
Add drafts for a new index, an overview and a user guide
santisoler Apr 5, 2022
ca7701a
Continue drafting coordinate systems tutorial page
santisoler Apr 5, 2022
28d3679
Improve geodetic coordinate system figure and its caption
santisoler Apr 6, 2022
207a2d1
Replace "coordinates projections" for "map projections"
santisoler Apr 6, 2022
9aeffc9
Rename figure
santisoler Apr 6, 2022
73365c3
Add figure for spherical coordinate system
santisoler Apr 6, 2022
c402fc4
Change admonition type note for important
santisoler Apr 6, 2022
b2e792f
Add sphinx_copybutton
santisoler Apr 6, 2022
2ca989f
Move tutorials to user_guide and use jupyter_sphinx
santisoler Apr 6, 2022
ee5ba70
Fix ambiguous reference to citing
santisoler Apr 6, 2022
465a1f0
Fill content in forward modelling with point sources
santisoler Apr 7, 2022
226bc62
Split big code cells into smaller ones
santisoler Apr 7, 2022
fde78bf
Change title of subsubsection
santisoler Apr 7, 2022
54b6de6
Remove repeated definition of point source
santisoler Apr 11, 2022
ca48e72
Add guide for modelling prisms
santisoler Apr 11, 2022
74b962e
Add margin to paragraphs after jupyter_containers
santisoler Apr 14, 2022
eb2684b
Replace gravity for gravitational
santisoler Apr 15, 2022
e6d6394
Start writing about tesseroids
santisoler Apr 18, 2022
fd2fa7e
Fix sentence
santisoler Apr 18, 2022
16e0475
Start writing about gravity disturbances
santisoler Apr 18, 2022
fd67bad
Add more content to gravity disturbance
santisoler Apr 19, 2022
0e4dcda
Reduce shape of grids in coordinate system
santisoler Apr 19, 2022
bec99e6
Fix proper reference label to gravity disturbance
santisoler Apr 19, 2022
0ab33ce
Add topographic correction page to user guide
santisoler Apr 20, 2022
80b2281
Use ensaio in the new user guide
santisoler Apr 22, 2022
cf57541
Merge branch 'main' into improve-docs
santisoler Apr 22, 2022
567e248
Merge branch 'main' into improve-docs
santisoler May 23, 2022
7c92439
Add custom CSS for the jupyter-sphinx code blocks
santisoler May 23, 2022
58d2a79
Update topographic correction guide
santisoler May 23, 2022
760758d
Merge branch 'improve-docs' of github.com:fatiando/harmonica into imp…
santisoler May 23, 2022
b4d0106
Start adding pages for equivalent sources
santisoler May 23, 2022
e8fcc87
Add user guide for estimating eqs hyperparameters
santisoler May 24, 2022
4949efa
Improve some toctrees
santisoler May 27, 2022
d16c4a0
Merge branch 'main' into improve-docs
santisoler May 27, 2022
1781d5f
Generate grids in user guide with the new coordinates argument
santisoler May 27, 2022
27012d3
Add content to the block-averaged equivalent sources page
santisoler May 27, 2022
7cb3e0f
Merge branch 'main' into improve-docs
santisoler May 31, 2022
aff7915
Add guide for gradient-boosted equivalent sources
santisoler May 31, 2022
fda47b5
Fix broken links
santisoler May 31, 2022
1ab1cde
Fix broken links
santisoler May 31, 2022
f30a73f
Add content to equivalent sources in spherical coordinates
santisoler Jun 1, 2022
76c0ca8
Add doc/versions.rst file
santisoler Jun 1, 2022
d0376ba
Make home admonition more welcoming
santisoler Jun 3, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ dist/
doc/_build
doc/api/generated
doc/gallery
doc/tutorials
doc/sample_data
.ipynb_checkpoints
*.egg-info
Expand Down
13 changes: 7 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,13 @@ or send us a message on our
About
-----

*Harmonica* is a Python library for processing and modeling gravity and magnetic data.
It includes common processing steps, like calculation of Bouguer and terrain
corrections, reduction to the pole, upward continuation, equivalent sources, and more.
There are forward modeling functions for basic geometric shapes, like spheres, prisms,
polygonal prisms, and tesseroids. The inversion methods are implemented as classes with
an interface inspired by scikit-learn (like `Verde <https://www.fatiando.org/verde>`__).
*Harmonica* is a Python library for processing and modeling gravity and
magnetic data. It includes common processing steps, like calculation of Bouguer
and terrain corrections, reduction to the pole, upward continuation, equivalent
sources, and more. There are forward modeling functions for basic geometric
shapes, like point sources, prisms and tesseroids. The inversion methods are
implemented as classes with an interface inspired by scikit-learn (like `Verde
<https://www.fatiando.org/verde>`__).


Project goals
Expand Down
20 changes: 20 additions & 0 deletions doc/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,23 @@ span.project-version {
font-weight: 600;
margin-left: 5px;
}

/* Try to make the jupyter-sphinx style match sphinx-gallery for consistency */
div.jupyter_container {
border: none;
box-shadow: none;
}

div.jupyter_container .cell_input {
margin-bottom: 1.15rem;
border-radius: 0.4em;
box-shadow: 1px 1px 1px #d8d8d8;
}

div.jupyter_container .cell_output {
margin-bottom: 1.15rem;
}

.jupyter_container div.code_cell pre {
padding: 10px;
}
Loading