Metadata-Version: 2.4
Name: bordado
Version: 0.5.0
Summary: Create, manipulate, and split geographic coordinates
Author-email: The Bordado Developers <fatiandoaterra@protonmail.com>
Maintainer-email: Leonardo Uieda <leo@uieda.com>
License-Expression: BSD-3-Clause
Project-URL: Documentation, https://www.fatiando.org/bordado
Project-URL: Changelog, https://www.fatiando.org/bordado/latest/changes.html
Project-URL: Bug Tracker, https://github.com/fatiando/bordado/issues
Project-URL: Source Code, https://github.com/fatiando/bordado
Keywords: geoscience,geophysics
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
License-File: AUTHORS.md
Requires-Dist: numpy>=1.23
Requires-Dist: scipy>=1.8
Dynamic: license-file

<h1><img src="https://github.com/fatiando/bordado/raw/main/doc/_static/readme-banner.png" alt="Bordado"></h1>

<p align="center"><strong>Create, manipulate, and split geographic coordinates</strong></p>

<p align="center">
<a href="https://www.fatiando.org/bordado"><strong>Documentation</strong> (latest)</a> •
<a href="https://www.fatiando.org/bordado/dev"><strong>Documentation</strong> (development)</a> •
<a href="https://github.com/fatiando/bordado/blob/main/CONTRIBUTING.md"><strong>Contribute</strong></a> •
<a href="https://www.fatiando.org/contact/"><strong>Contact</strong></a> •
<a href="https://github.com/orgs/fatiando/discussions"><strong>Ask a question</strong></a> •
<a href="https://www.fatiando.org/bordado/latest/citing.html"><strong>Cite</strong></a>
</p>

<p align="center">
Part of the
<a href="https://www.fatiando.org"><strong>Fatiando a Terra</strong></a>
project.
</p>

<p align="center">
<a href="https://pypi.python.org/pypi/bordado"><img src="http://img.shields.io/pypi/v/bordado.svg?style=flat-square" alt="Latest version on PyPI"></a>
<a href="https://github.com/conda-forge/bordado-feedstock"><img src="https://img.shields.io/conda/vn/conda-forge/bordado.svg?style=flat-square" alt="Latest version on conda-forge"></a>
<a href="https://pypi.python.org/pypi/bordado"><img src="https://img.shields.io/pypi/pyversions/bordado.svg?style=flat-square" alt="Compatible Python versions."></a>
<a href="https://doi.org/10.5281/zenodo.15051755"><img src="https://img.shields.io/badge/doi-10.5281%2Fzenodo.15051755-blue?style=flat-square" alt="DOI used to cite bordado"></a>
</p>

## About

**Bordado**  (Portuguese for "embroidery") is a Python package for creating,
manipulating, and splitting geographic and Cartesian coordinates.
It can generate coordinates at regular intervals by specifying the number of
points or the spacing between points. Bordado takes care of adjusting the
spacing to make sure it matches the specified domain/region. It also contains
functions for splitting coordinates into spatial blocks and more.

> Many of these functions used to be in
> [Verde](https://www.fatiando.org/verde/) but were moved to Bordado to make
> them more accessible without all of the extra dependencies that Verde
> requires.

## Project goals

* Generate regular point distributions in grids, profiles, lines, etc.
* Provide functions for fast spatial blocking and coordinates manipulation.
* Have minimal dependencies to make it easy to install and light to pick up for
  other projects.

## Project status

**Bordado is ready for use but still changing**.
This means that we are still adding a lot of new features, and sometimes we make
changes to the ones we already have while we try to improve the software based
on users' experience, test new ideas, take better design decisions, etc. Some of
these changes could be **backwards incompatible**. Keep that in mind before you
update Harmonica to a newer version.

**We welcome feedback and ideas!** This is a great time to bring new ideas on
how we can improve the project.
[Join the conversation](https://www.fatiando.org/contact) or submit
[issues on GitHub](https://github.com/fatiando/bordado/issues).

## Getting involved

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

👩🏾‍💻 **Contributing to project development:**
Please read our
[Contributing Guide](https://github.com/fatiando/bordado/blob/main/CONTRIBUTING.md)
to see how you can help and give feedback.

🧑🏾‍🤝‍🧑🏼 **Code of conduct:**
This project is released with a
[Code of Conduct](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.

> **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** (giving feedback, teaching, writing documentation, and more).
>
> *This disclaimer was adapted from the*
> [MetPy project](https://github.com/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://github.com/fatiando/bordado/blob/main/LICENSE.txt).
