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 README to match Verde and Boule #358

Merged
merged 3 commits into from
Nov 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
108 changes: 35 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<img src="https:/fatiando/harmonica/raw/main/doc/_static/readme-banner.png" alt="Harmonica">

<h1 align="center">Harmonica</h1>

<h2 align="center">Processing and modelling gravity and magnetic data</h2>

<p align="center">
Expand All @@ -22,10 +20,10 @@ src="http://img.shields.io/pypi/v/harmonica.svg?style=flat-square"
alt="Latest version on PyPI"
/>
</a>
<a href="https:/fatiando/harmonica/actions">
<a href="https:/conda-forge/harmonica-feedstock">
<img
src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ffatiando%2Fharmonica%2Fbadge%3Fref%3Dmain&amp;style=flat-square&amp;logo=none"
alt="GitHub Actions status"
src="https://img.shields.io/conda/vn/conda-forge/harmonica.svg?style=flat-square"
alt="Latest version on conda-forge"
/>
</a>
<a href="https://codecov.io/gh/fatiando/harmonica">
Expand All @@ -48,15 +46,6 @@ alt="Digital Object Identifier for the Zenodo archive"
</a>
</p>


# Disclaimer

🚨 **This package is in early stages of design and implementation.** 🚨

We welcome any feedback and ideas! Let us know by submitting [issues on
Github](https:/fatiando/harmonica/issues) or send us a message on
our [Slack chatroom](http://contact.fatiando.org).

# About

*Harmonica* is a Python library for processing and modeling gravity and
Expand All @@ -79,84 +68,57 @@ These are the long-term goals for Harmonica:
- Easily extended code to enable research on the development of new
methods.

See the [Github milestones](https:/fatiando/harmonica/milestones)
See the [GitHub milestones](https:/fatiando/harmonica/milestones)
for short-term goals.

Things that will *not* be covered in Harmonica:

- Multi-physics partial differential equation solvers. Use
[SimPEG](http://www.simpeg.xyz/) or [PyGIMLi](https://www.pygimli.org/)
instead.
- Generic grid processing methods (like horizontal derivatives and FFT). These
should be implemented in [Verde](https://www.fatiando.org/verde).
- Generic grid processing methods (like horizontal derivatives and FFT). We'll
rely on [Verde](https://www.fatiando.org/verde),
[xrft](https://xrft.readthedocs.io/en/latest/) and
[xarray](https://xarray.dev) for those.
- Data visualization.
- GUI applications.

# Contacting Us

- Most discussion happens [on Github](https:/fatiando/harmonica).
Feel free to [open an
issue](https:/fatiando/harmonica/issues/new) or comment on any
open issue or pull request.
- We have [chat room on Slack](http://contact.fatiando.org) where you can ask
questions and leave comments.
## Project status

# Contributing
🚨 **Harmonica is in early stages of design and implementation.** 🚨

## Code of conduct
We welcome any feedback and ideas! Let us know by submitting
[issues on GitHub](https:/fatiando/harmonica/issues) or
[joining our community](https://www.fatiando.org/contact).

Please note that this project is released with a [Contributor Code of
Conduct](https:/fatiando/harmonica/blob/main/CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.

## Contributing Guidelines

Please read our [Contributing
Guide](https:/fatiando/harmonica/blob/main/CONTRIBUTING.md) to see
how you can help and give feedback.
## Getting involved

## Imposter syndrome disclaimer
🗨️ **Contact us:**
Find out more about how to reach us at
[fatiando.org/contact](https://www.fatiando.org/contact/).

**We want your help.** No, really.
👩🏾‍💻 **Contributing to project development:**
Please read our
[Contributing Guide](https:/fatiando/harmonica/blob/main/CONTRIBUTING.md)
to see how you can help and give feedback.

There may be a little voice inside your head that is telling you that
you're not ready to be an open source contributor; that your skills
aren't nearly good enough to contribute. What could you possibly offer?

We assure you that the little voice in your head is wrong.

**Being a contributor doesn't just mean writing code**. Equally
important contributions include: writing or proof-reading documentation,
suggesting or implementing tests, or even giving feedback about the
project (including giving feedback about the contribution process). If
you're coming to the project with fresh eyes, you might see the errors
and assumptions that seasoned contributors have glossed over. If you can
write any code at all, you can contribute code to open source. We are
constantly trying out new skills, making mistakes, and learning from
those mistakes. That's how we all improve and we are happy to help
others learn.
🧑🏾‍🤝‍🧑🏼 **Code of conduct:**
This project is released with a
[Code of Conduct](https:/fatiando/community/blob/main/CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.

*This disclaimer was adapted from the* [MetPy
project](https:/Unidata/MetPy).
> **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**.
>
> *This disclaimer was adapted from the*
> [MetPy project](https:/Unidata/MetPy).

# 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](https:/fatiando/harmonica/blob/main/LICENSE.txt).

# Documentation for other versions

- [Development](http://www.fatiando.org/harmonica/dev) (reflects the *main*
branch on Github)
- [Latest release](http://www.fatiando.org/harmonica/latest)
- [v0.5.1](http://www.fatiando.org/harmonica/v0.5.1)
- [v0.5.0](http://www.fatiando.org/harmonica/v0.5.0)
- [v0.4.0](http://www.fatiando.org/harmonica/v0.4.0)
- [v0.3.3](http://www.fatiando.org/harmonica/v0.3.3)
- [v0.3.2](http://www.fatiando.org/harmonica/v0.3.2)
- [v0.3.1](http://www.fatiando.org/harmonica/v0.3.1)
- [v0.3.0](http://www.fatiando.org/harmonica/v0.3.0)
- [v0.2.1](http://www.fatiando.org/harmonica/v0.2.1)
- [v0.2.0](http://www.fatiando.org/harmonica/v0.2.0)
- [v0.1.0](http://www.fatiando.org/harmonica/v0.1.0)
[`LICENSE.txt`](https:/fatiando/harmonica/blob/main/LICENSE.txt).
Binary file modified doc/_static/readme-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
128 changes: 57 additions & 71 deletions doc/_static/readme-banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.