Python C Objective-C Cuda JavaScript C++
Clone or download
ngoldbaum Merge pull request #1886 from git-abhishek/viz-profile-plots-save-to-…
…tempdir

Refactor, save png to temporary directory, clean-up temp dir after tests
Latest commit 65b895b Jul 14, 2018
Permalink
Failed to load latest commit information.
.github Add pull request and issue template for github Apr 27, 2017
benchmarks Spelling fixes Oct 2, 2017
doc Merge pull request #1857 from MatthewTurk/issue1332 Jun 30, 2018
docker Add test for fedora:latest Jan 9, 2015
scripts remove my key Dec 12, 2017
tests update test answers Jul 3, 2018
yt Merge pull request #1886 from git-abhishek/viz-profile-plots-save-to-… Jul 14, 2018
.codecov.yml Updating config to not fail the pushed patch May 28, 2018
.coveragerc Switching to Codecov from Coveralls May 25, 2018
.gitignore add two new autogenerated c files to gitignore Jun 1, 2018
.hgchurn Backporting PR #2419 https://bitbucket.org/yt_analysis/yt/pull-reques… Oct 14, 2016
.hgignore Move fnv_hash to its own Cython file so it may be used in multiple pl… Feb 27, 2017
.hgtags Added tag yt-3.3.5 for changeset bf36e108e911 Mar 6, 2017
.mailmap update mailmap and credits Jun 28, 2018
.python-version Remove changes Jul 6, 2015
.travis.yml Merge pull request #1840 from ngoldbaum/py34-nomore Jun 30, 2018
CITATION Don't use /apjs macro in citation examples. Closes #1286 Sep 28, 2016
CONTRIBUTING.rst Fixes link about relicensing post Jun 1, 2018
COPYING.txt Update mailing list locations. Jan 18, 2018
CREDITS update mailmap and credits Jun 28, 2018
MANIFEST.in Adding mesh_types.yaml to MANIFEST.in Aug 3, 2016
README.md updating the badge May 25, 2018
appveyor.yml Merge pull request #1841 from git-abhishek/viz-colormaps Jun 29, 2018
clean.sh Replace hg purge by git clean May 6, 2017
nose.cfg Switching to Codecov from Coveralls May 25, 2018
setup.cfg removing venv dir since now we do flake8 yt/ Jun 4, 2018
setup.py drop support for Python3.4 Jun 29, 2018
setupext.py Merge pull request #1696 from ngoldbaum/omp-windows Feb 16, 2018

README.md

The yt Project

Users' Mailing List Devel Mailing List Build Status codecov Latest Documentation Data Hub Powered by NumFOCUS

yt is an open-source, permissively-licensed python package 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

If you're using conda with conda-forge, you can install the most recent stable version by running:

conda install -c conda-forge yt

or by doing:

pip install yt

If you want the latest nightly build, you can manually install from our repository:

conda install -c http://use.yt/with_conda yt

To get set up with a development version, you can clone this repository and install like this:

git clone https://github.com/yt-project/yt yt-git
cd yt-git
pip install -e .

To set up yt in a virtualenv (and there are many good reasons to do so!) you can follow this prescription:

# Assuming you have cd'd into yt-git
# It is conventional to create virtualenvs at ~/.virtualenv/
$ mkdir -p ~/.virtualenv
# Assuming your version of Python 3 is 3.4 or higher,
# create a virtualenv named yt
$ python3 -m venv ~/.virtualenv/yt
# Activate it
$ source ~/.virtualenv/yt/bin/activate
# Make sure you run the latest version of pip
$ pip install --upgrade pip
$ pip install -e .
# Output installed packages
$ pip freeze

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.