Skip to content
/ pyTNG Public

Python library for interactions with the IllustrisTNG simulation suite.

Notifications You must be signed in to change notification settings

WikGroup/pyTNG

Repository files navigation

Image

PyTNG

yt-project pre-commit docs Python testing Coverage Code style: black

PyTNG is a light-weight python library for interacting with the Illustris / IllustrisTNG simulation suites. pyTNG is designed to simplify API interaction and provide easy transfer of data from the Illustris API to python and then to yt datasets for further analysis. Using pyTNG, you can easily manage large queries to the API, sequential downloading, and data visualization.

pyTNG is not officially affiliated with the IllustrisTNG team; all rights to simulations hosted through the Illustris system belong to the TNG science team and not to the developers of this package.

Installation

pyTNG is currently in a pre-release stage of development. If you'd like to use this package, you'll need to install it directly from the git repository. To do so,

>>> git clone https://www.github.com/WikGroup/pyTNG

Once the clone of the repository has been generated, navitage into the /pyTNG/ module directory and run

>>> pip install .

The package will now be installed on your system.

Providing a TNG API-key

Access to the TNG data is predicated on the use of an api-key, which the user must obtain on their own. Once you've created a TNG account and have an api-key, it can be set in the configuration for the package using

>>> pytng-apikey <USER_API_KEY>

Contributing to pyTNG

Code of Conduct

Licence

About

Python library for interactions with the IllustrisTNG simulation suite.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published