Skip to main content

An analysis and visualization toolkit for volumetric data

Project description

The yt Project

PyPI Supported Python Versions Latest Documentation Users' Mailing List Devel Mailing List Data Hub Powered by NumFOCUS Sponsor our Project

Build and Test pre-commit.ci status Code style: black Imports: isort

yt is an open-source, permissively-licensed Python library for analyzing and visualizing volumetric data.

yt supports structured, variable-resolution meshes, unstructured meshes, and discrete or sampled data such as particles. Focused on driving physically-meaningful inquiry, yt has been applied in domains such as astrophysics, seismology, nuclear engineering, molecular dynamics, and oceanography. Composed of a friendly community of users and developers, we want to make it easy to use and develop - we'd love it if you got involved!

We've written a method paper you may be interested in; if you use yt in the preparation of a publication, please consider citing it.

Code of Conduct

yt abides by a code of conduct partially modified from the PSF code of conduct, and is found in our contributing guide.

Installation

You can install the most recent stable version of yt either with conda from conda-forge:

conda install -c conda-forge yt

or with pip:

python -m pip install yt

More information on the various ways to install yt, and in particular to install from source, can be found on the project's website.

Getting Started

yt is designed to provide meaningful analysis of data. We have some Quickstart example notebooks in the repository:

If you'd like to try these online, you can visit our yt Hub and run a notebook next to some of our example data.

Contributing

We love contributions! yt is open source, built on open source, and we'd love to have you hang out in our community.

We have developed some guidelines for contributing to yt.

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 to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

(This disclaimer was originally written by Adrienne Lowe for a PyCon talk, and was adapted by yt based on its use in the README file for the MetPy project)

Resources

We have some community and documentation resources available.

Is your code compatible with yt ? Great ! Please consider giving us a shoutout as a shiny badge in your README

  • markdown
[![yt-project](https://img.shields.io/static/v1?label="works%20with"&message="yt"&color="blueviolet")](https://yt-project.org)
  • rst
|yt-project|

.. |yt-project| image:: https://img.shields.io/static/v1?label="works%20with"&message="yt"&color="blueviolet"
   :target: https://yt-project.org

Powered by NumFOCUS

yt is a fiscally sponsored project of NumFOCUS. If you're interested in supporting the active maintenance and development of this project, consider donating to the project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for yt, version 4.0.1
Filename, size File type Python version Upload date Hashes
Filename, size yt-4.0.1-cp36-cp36m-macosx_10_14_x86_64.whl (18.7 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size yt-4.0.1-cp36-cp36m-manylinux2014_x86_64.whl (61.6 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size yt-4.0.1-cp36-cp36m-win32.whl (17.2 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size yt-4.0.1-cp36-cp36m-win_amd64.whl (17.9 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size yt-4.0.1-cp37-cp37m-macosx_10_14_x86_64.whl (18.7 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size yt-4.0.1-cp37-cp37m-manylinux2014_x86_64.whl (61.5 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size yt-4.0.1-cp37-cp37m-win32.whl (17.2 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size yt-4.0.1-cp37-cp37m-win_amd64.whl (17.9 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size yt-4.0.1-cp38-cp38-macosx_10_14_x86_64.whl (18.7 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size yt-4.0.1-cp38-cp38-manylinux2014_x86_64.whl (64.5 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size yt-4.0.1-cp38-cp38-win32.whl (17.3 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size yt-4.0.1-cp38-cp38-win_amd64.whl (18.0 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size yt-4.0.1-cp39-cp39-macosx_10_9_x86_64.whl (13.5 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size yt-4.0.1-cp39-cp39-manylinux2014_x86_64.whl (39.7 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size yt-4.0.1-cp39-cp39-win32.whl (16.7 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size yt-4.0.1-cp39-cp39-win_amd64.whl (13.1 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size yt-4.0.1.tar.gz (12.6 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page