Skip to content

Latest commit

 

History

History
91 lines (72 loc) · 4.31 KB

README.md

File metadata and controls

91 lines (72 loc) · 4.31 KB
Raw

Ensaio

Practice datasets to probe your code

Documentation (latest) • Documentation (main branch) • Contributing • Contact

Part of the Fatiando a Terra project

Latest version on PyPI Latest version on conda-forge Test coverage status Compatible Python versions. DOI used to cite Ensaio

About

Ensaio (Portuguese for "rehearsal") is a Python package for downloading open-access sample datasets for Geoscience. It taps into the Fatiando a Terra FAIR data collection that is designed for use in tutorials, documentation, and teaching.

It uses Pooch to manage downloading and caching the data on your computer. This means that datasets are only downloaded if they can't be found on your computer already.

Project goals

  • Provide minimal code for downloading our sample data (basically just creates the relevant Pooch code).
  • Only download and let the user load the data. This helps make tutorials and examples more easily extended to a user's own data.
  • Be fully backwards compatible. We achieve this by separating data versions from Ensaio versions. Data fetching functions allow you to choose any data version that is older than the version of Ensaio that's installed. Major releases of Ensaio will be few and far between (if any).

Project status

Ensaio is ready for use but still changing. This means that we sometimes break backwards compatibility as we try to improve the software based on user experience, new ideas, better design decisions, etc. Please keep that in mind before you update 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 or submit issues on GitHub.

Getting involved

🗨️ Contact us: Find out more about how to reach us at fatiando.org/contact.

👩🏾‍💻 Contributing to project development: Please read our Contributing Guide to see how you can help and give feedback.

🧑🏾‍🤝‍🧑🏼 Code of conduct: This project is released with a Code of Conduct. 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.

This disclaimer was adapted from the MetPy project.

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.