Quickstart Guide#

Welcome to Pisces! This guide will help you get started with the Pisces library, which provides a range of astrophysical models and utilities for simulating and analyzing various systems including galaxy clusters, galaxies, and stellar objects.

Installation#

Pisces is currently in development and has not been released on PyPI. To install Pisces, you can clone the repository from GitHub and install it using pip. Here are the steps:

  1. Clone the Pisces repository:

    git clone https://github.com/Pisces-Project/pisces

  2. Navigate to the cloned directory:

    cd pisces

  3. Install Pisces using pip:

    pip install -e .

This will install Pisces in editable mode, allowing you to make changes to the code and see them reflected immediately.

Important

In the future, Pisces will be available on PyPI, and you will be able to install it using:

pip install pisces

Getting Started#

To get started using Pisces, we recommend the following steps:

  1. Look through the documentation available at Pisces User Guide to familiarize yourself with the relevant modules and the general structure of the library. This documentation is written with brevity in mind to ensure that you can quickly find the information you need and get started with your work.

  2. Explore the examples provided in the Pisces Example Gallery document. These examples will cover most of the basic functionality of Pisces and will help you understand how to use the library effectively.

If you have specific questions about using Pisces, encounter a bug, or have suggestions for improvements, please feel free to open an issue on the Pisces GitHub repository. We welcome contributions and feedback from the community to help improve the library.

Developers#

Are you interested in helping to develop Pisces? We welcome contributions from developers of all skill levels. To get started as a developer, please refer to the Pisces Developer Guide for information on how to contribute, coding standards, and the development workflow.