Velociraptor catalogue reading routines.
Project description
Velociraptor Python Library
Velociraptor catalogues provide
a signifciant amount of information, but applying units to it can be painful.
Here, the unyt
python library is used to automatically apply units to
velociraptor data and perform generic halo-catalogue reduction. This library
is primarily intended to be used on SWIFT data that
has been post-processed with velociraptor, but can be used for any
velociraptor catalogue.
The internals of this library are based heavily on the internals of the
swiftsimio
library, and essentially
allow the velociraptor catalogue to be accessed in a lazy, object-oriented
way. This enables users to be able to reduce data quickly and in a
computationally efficient manner, without having to resort to using the
h5py
library to manually load data (and hence manually apply units)!
Requirements
The velociraptor library requires:
unyt
and its dependenciesh5py
and its dependenciespython3.6
or above
Note that for development, we suggest that you have pytest
and black
installed. To create the plots in the example directory, you will need
the plotting framework matplotlib
.
Installation
You can install this library from PyPI using:
pip3 install velociraptor
Documentation
Full documentation is available on ReadTheDocs.
Why a custom library?
This custom library, instead of something like pandas
, allows us to
only load in the data that we require, and provide significant
context-dependent features that would not be available for something
generic. One example of this is the automatic labelling of properties,
as shown in the below example.
from velociraptor import load
from velociraptor.tools import get_full_label
catalogue = load("/path/to/catalogue.properties")
stellar_masses = catalogue.apertures.mass_star_30_kpc
stellar_masses.convert_to_units("msun")
print(get_full_label(stellar_masses))
This outputs "Stellar Mass $M_*$ (30 kpc) $\left[M_\odot\right]$", which is easy to add as, for example, a label on a plot.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file velociraptor-0.18.0.tar.gz
.
File metadata
- Download URL: velociraptor-0.18.0.tar.gz
- Upload date:
- Size: 88.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0b471155aa1a7a34a968cb812d8260d77c165ea32b7e103f7f2c0a7c20ea9ed |
|
MD5 | b040ea8d0b70d61b881d10fc17009916 |
|
BLAKE2b-256 | 6eb95e59f948b9f6ad8a6ed0f52b378a41f43bf21f57b8a1482165f61eb1f73a |
File details
Details for the file velociraptor-0.18.0-py3-none-any.whl
.
File metadata
- Download URL: velociraptor-0.18.0-py3-none-any.whl
- Upload date:
- Size: 99.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56d927ec87184f84a2050854fe8b163351524919cdeed157be70aeda585b4594 |
|
MD5 | e44063a9e3e3f4ba6e92ae78949b6b17 |
|
BLAKE2b-256 | 1225a13e6fc30b16d39407cd10289b490f79aa25600d553b5665c22263d52446 |