Installation

Stable release

To install unyt, run this command in your terminal:

$ python -m pip install unyt

If you have a C compiler available, we also suggest installing fastcache, which will improve the performance of SymPy.

If you don’t have pip installed, this Python installation guide can guide you through the process.

If you use conda, unyt is available via conda-forge:

$ conda install -c conda-forge unyt

It is not necessary to explicitly install fastcache if you use conda because it will be installed automatically as a dependency of SymPy.

From source

The sources for unyt can be downloaded from the Github repo.

If you don’t need an editable install, the following line is all you need to run

$ python -m pip install git+https//github.com/yt-project/unyt.git

If you would like to make an “editable” where you can directly edit the Python source files of the installed version of unyt, then you can download the latest version from Github either with git

$ git clone git://github.com/yt-project/unyt

or download the tarball:

$ curl -OL https://github.com/yt-project/unyt/tarball/main

Once you have a copy of the source, you can install it by navigating to the root of the installation and issuing the following command:

$ python -m pip install -e .

Running the tests

You can check that unyt is working properly by running the unit tests on your installed copy:

>>> import unyt
>>> unyt.test()  

Note that you’ll need pytest installed for this function to run.