Skip to content

Pisces-Project/Pisces

Repository files navigation

Pisces

Code Ruff pre-commit Works with yt
Documentation Latest Docs Latest Docs Docstring style: numpydoc
GitHub GitHub Contributors Last Commit Commit style: Conventional + Gitmoji Commit style: Conventional Commits
PyPi Coming Soon

Pisces (or Py-ICs) is an open-source toolkit for constructing models of astrophysical systems and generating data for simulations. Designed for flexibility and ease of use, Pisces enables researchers to create a wide range of astrophysical models—including galaxies, galaxy clusters, and early universe perturbations—whether for direct analysis or as input for simulation software.

Rather than being limited to initial condition generation, Pisces provides a modular and extensible framework that supports a variety of scientific use cases. It is built to integrate seamlessly with major astrophysical simulation tools through dedicated frontends, ensuring broad compatibility and interoperability.

The core package is structured to facilitate customization and development, allowing users to adapt it to their specific research needs. All essential tools for model construction are included, with an emphasis on accessibility and ease of extension.

Development takes place on GitHub. If you encounter any issues, documentation gaps, or have feature suggestions, we encourage you to submit them via the repository's issues page.

Getting Started

To get started using Pisces, check out the Quickstart Guide, which provides an overview of installation, basic usage, and links to further resources. You can also explore the Full Documentation for comprehensive guides, API references, and examples.

Acknowledgment

If you use Pisces for academic work, please include a statement in your publication similar to:

Initial conditions were generated using Pisces (version), an initial conditions generator for astrophysical simulations, developed by Eliza Diggins and available at https://github.com/Pisces-Project/pisces.

About

Pisces (or PyICs) is a python package for generating astrophysical models for N-body / hydrodynamical simulation. It supports cosmological ICs, star clusters, galaxies, and clusters of galaxies.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors