Metadata-Version: 2.4
Name: galstreams
Version: 1.2.1
Summary: MW stream library toolkit
Project-URL: Homepage, https://github.com/cmateu/galstreams
Project-URL: Bug Tracker, https://github.com/cmateu/galstreams/issues
Author-email: "C. Mateu" <cmateu@fcien.edu.uy>
License: BSD 3-Clause License
        
        Copyright (c) 2017, Cecilia Mateu
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: AUTHORS
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: astropy
Requires-Dist: gala
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Provides-Extra: test
Requires-Dist: pytest-astropy; extra == 'test'
Requires-Dist: pytest-cov>=3; extra == 'test'
Requires-Dist: pytest>=6; extra == 'test'
Description-Content-Type: text/markdown

# **galstreams**

![see plot here](notebooks/fig_all_streams_lib.png?raw=true "galstreams 06-2024")

### DESCRIPTION:

This is the *galstreams* Library of Stellar Streams in the Milky Way. Since v1.0 stellar streams are supported as track SkyCoord objects (Track6D), rather than the Footprint objects provided in the previous version (v0.1). The main features of the library since v1.0 are:

-  Celestial, distance, proper motion and radial velocity tracks for each stream (pm/vrad when available) stored as astropy SkyCoord objects
-  Stream's (heliocentric) coordinate frame realised as astropy reference frame
-  Stream's end-points and mid-point
- Polygon Footprints
-  Pole (at mid point) and pole tracks in the heliocentric and Galactocentric (GSR) frames
-  Angular momentum track in a heliocentric reference frame at rest with respect to the Galactic centre
-  Summary object for the full library: Uniformly reported stream length, end points and mid-point, heliocentric and Galactocentric mid-pole, track and discovery references and information flag denoting which of the 6D attributes (sky, distance, proper motions and radial velocity) are available in the track object.

The latest version (1.2) of the library includes >200 stream tracks corresponding to 141 distinct stellar streams. The library (v1.0) is described in detail in [Mateu (2023)](https://ui.adsabs.harvard.edu/link_gateway/2023MNRAS.520.5225M/doi:10.1093/mnras/stad321).

### LATEST CHANGES

- 2026/06 Galstreams added to PyPi, pip install now supported. V1.2 tagged.
- 2024/06 major track update. Over 80 new tracks included (40 new streams, over 40 tracks updated), Vrad tracks included for S5, plus several other individual stream tracks added.
- 2023/05 Widths in phi2, pmphi1_cosphi2/phi2 are now implemented: median widths available in summary table.
- 2023/04 The quick plot method is back! Check out MWStreams.plot_stream_compilation() in the Quick plots section of the examples notebook
- 2023/04 Pandas (v1.3) unit handling error in summary attribute fixed (this fixes errors that came up in the newest pandas versions when accesing mws.summary using .loc)
- 2023/02 get_track_names_in_sky_window method added for convenience. It provides a list of the stream tracks present in a sky window with limits provided by the user in an arbitrary coordinate frame
- 2023/02 TOPCAT-friendly csv files containing all stream tracks, end-points, mid-points and the library summary table can now printed when the library is instantiated. They are stored by default in galstreams/tracks, but can be saved at any user-defined location if using the print_topcat_friendly_compilation method

### REQUIREMENTS

- Python modules required are NUMPY, SCIPY, MATPLOTLIB, ASTROPY and GALA. 
- Installing Basemap is highly recommended (but not needed) for more involved plots. If installing with conda, make sure to update the proj4 library before installing Basemap to avoid errors.

----------

### INSTALLATION

To install the latest development version of galstreams, use `pip` by running the
following command in a terminal:

    pip install git+https://github.com/cmateu/galstreams

Or, download or clone the source code, change directory into the galstreams repository
folder and run:

    pip install .

If importing galstreams fails due to a broken or missing gala installation (for example with a GSL or dlopen error), install gala using conda-forge:

    conda install -c conda-forge gala

----------
# Quick Guide

For a detailed walk through the library please see the example Python notebooks provided [here](notebooks/).
