Code abstraction of objects (galaxies) in simulations.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for kyleaoman from gravatar.com kyleaoman

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: GPL-3.0-or-later
    SPDX License Expression
  • Author: Kyle Oman
  • Requires: Python >=3.10
  • Provides-Extra: extra , velociraptor , all , testing , docs , dev
Classifiers
Report project as malware

Project description

Banner with logo showing a swift in a spiral and the text SWIFTGalaxy.

Python Version from PEP 621 TOML PyPI - Version JOSS doi:10.21105/joss.09278 pyOpenSci Peer-Reviewed ascl:2505.002 Project Status: Active – The project has reached a stable, usable state and is being actively developed. Zenodo DOI Build Status Documentation Status CodeCov status Ruff

SWIFTGalaxy is an open-source astrophysics module that extends SWIFTSimIO tailored to analyses of particles belonging to individual galaxies simulated with SWIFT. It inherits from and extends the functionality of the SWIFTDataset. It understands the content of halo catalogues (supported: Velociraptor, Caesar, SOAP) and therefore which particles belong to a galaxy or other group of particles, and its integrated properties. The particles occupy a coordinate frame that is enforced to be consistent, such that particles loaded on-the-fly will match e.g. rotations and translations of particles already in memory. Intuitive masking of particle datasets is also enabled. Utilities to make working in cylindrical and spherical coordinate systems more convenient are also provided. Finally, tools to iterate efficiently over multiple galaxies are also provided.

Installation is as simple as pip install swiftgalaxy.

To install optional dependencies to support Velociraptor catalogues use pip install swiftgalaxy[velociraptor]. For Caesar support use:

pip install git+https://github.com/dnarayanan/caesar.git

No additional dependencies are needed for reading SOAP catalogues. If you want to generate example input files for SOAP, you should install:

pip install git+https://github.com/SWIFTSIM/soap.git

Once installed, creating a SWIFTGalaxy object to get started with analysis is simple! For instance, for a SWIFT simulation with a SOAP-format halo catalogue (an example - 300 MB - will be automatically downloaded):

from swiftgalaxy import SWIFTGalaxy, SOAP
from swiftgalaxy.demo_data import web_examples

sg = SWIFTGalaxy(
    web_examples.virtual_snapshot,
    SOAP(web_examples.soap, soap_index=0)
)

# access data for particles belonging to the galaxy:
sg.gas.temperatures

# access integrated properties from the halo catalogue
sg.halo_catalogue.spherical_overdensity_200_crit.soradius

# automatically generated spherical/cylindrical coordinates:
sg.gas.spherical_coordinates.r

# consistent coordinate transformations of all particles, even those not loaded yet:
from scipy.spatial.transform import Rotation
sg.rotate(Rotation.from_euler("x", 90, degrees=True))

# compatible with swiftsimio visualisation:
import numpy as np
import unyt as u
from swiftsimio import cosmo_array
from swiftsimio.visualisation import project_gas
import matplotlib.pyplot as plt
img = project_gas(
    sg,
    periodic=False,
    resolution=256,
    region=cosmo_array(
        [-30, 30, -30, 30],
        u.kpc,
        comoving=True,
        scale_factor=sg.metadata.a,
        scale_exponent=1
    ),
)
plt.imsave("eagle6_galaxy.png", np.log10(img.T), origin="lower", cmap="inferno")
eagle6_galaxy.png

Examples

More usage examples can be found in the examples folder on github.

Citing SWIFTGalaxy

If your use of SWIFTGalaxy leads to a publication, please cite the JOSS paper (ADS listing). You may also cite the swiftgalaxy entry in the ASCL (indexed on ADS). Ideally specify the version used (Zenodo DOI, git commit ID and/or version number) and link to the github repository.

@ARTICLE{2025JOSS...10.9278O,
    author = {{Oman}, Kyle A.},
    title = "{SWIFTGalaxy: a Python package to work with particle groups from SWIFT simulations}",
    journal = {The Journal of Open Source Software},
    keywords = {astronomy, simulations},
    year = 2025,
    month = oct,
    volume = {10},
    number = {114},
    eid = {9278},
    pages = {9278},
    doi = {10.21105/joss.09278},
    adsurl = {https://ui.adsabs.harvard.edu/abs/2025JOSS...10.9278O},
    adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@MISC{
    2025ascl.soft05002O,
    author = {{Oman}, Kyle A.},
    title = "{swiftgalaxy}",
    keywords = {Software},
    howpublished = {Astrophysics Source Code Library, record ascl:2505.002},
    year = 2025,
    month = may,
    eid = {ascl:2505.002},
    pages = {ascl:2505.002},
    archivePrefix = {ascl},
    eprint = {2505.002},
    adsurl = {https://ui.adsabs.harvard.edu/abs/2025ascl.soft05002O},
    adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Please also consider the citations requested for SWIFTSimIO.

Community

Code contributions are very welcome! A good place to start is the contributing guide and how to set up a development environment.

SWIFTGalaxy is licensed under GPL-3.0 and community members are expected to abide by the code of conduct.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for kyleaoman from gravatar.com kyleaoman

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: GPL-3.0-or-later
    SPDX License Expression
  • Author: Kyle Oman
  • Requires: Python >=3.10
  • Provides-Extra: extra , velociraptor , all , testing , docs , dev
Classifiers

Release history Release notifications | RSS feed

This version

2.3.2

2.3.1

2.3.0

2.2.1

2.2.0

2.1.3

2.1.2

2.1.1

2.0.3

2.0.2

2.0.1

2.0.0

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.0

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Download files

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

Source Distribution

swiftgalaxy-2.3.2.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

swiftgalaxy-2.3.2-py3-none-any.whl (81.9 kB view details)

Uploaded Python 3

File details

Details for the file swiftgalaxy-2.3.2.tar.gz.

File metadata

  • Download URL: swiftgalaxy-2.3.2.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for swiftgalaxy-2.3.2.tar.gz
Algorithm Hash digest
SHA256 351e165bf847857707e390002a8b3f14e23aebe160ad8ea9dec26f03f48bf10e
MD5 f12246fc7194f28d63457f00b89d3db5
BLAKE2b-256 d684c383f82f32a7aa7422e07251bdc56038be5b5156ab00bdcf242f79e8f4df

See more details on using hashes here.

Provenance

The following attestation bundles were made for swiftgalaxy-2.3.2.tar.gz:

Publisher: python-publish.yml on SWIFTSIM/swiftgalaxy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file swiftgalaxy-2.3.2-py3-none-any.whl.

File metadata

  • Download URL: swiftgalaxy-2.3.2-py3-none-any.whl
  • Upload date:
  • Size: 81.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for swiftgalaxy-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9c962b7a8ac6feb76c1039fcfe74ac78cae2dda26c8e1aee2027420a02aad24f
MD5 e88efa92903fe7ebd8bc60982e5851b9
BLAKE2b-256 24ebfd1dec30bf64b27bb5bb71e8cdaf47687ba832defdd3d917c6be78aac1a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for swiftgalaxy-2.3.2-py3-none-any.whl:

Publisher: python-publish.yml on SWIFTSIM/swiftgalaxy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page