Metadata-Version: 2.1
Name: darkplotter
Version: 1.0.0
Summary: This package is an educational tool to teach undergradute students in astronomy about the gravitational potential and corresponding velocity curve as a function of radius for the Milky Way galaxy. After using this tool, students should understand that some form of dark matter must exist in order to explain the obsered velocity curve of the Milky Way.
Author-email: "Garcia-Cifuentes, K." <stivengarcia7113@gmail.com>, Bretton Simpson <bsimpson@ucsd.edu>, Elizabeth Moreno <Elizabeth@example.com>, Vyom Singh Rathore <rathorevyom04@gmail.com>, Dionysis Gakis <dgakis5@gmail.com>
Maintainer-email: Keneth Garcia <stivengarcia7113@gmail.com>, Bretton Simpson <bsimpson@ucsd.edu>
License: MIT License
        
        Copyright (c) 2024 Bretton Simpson
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/brettonsimpson/darkplotter
Project-URL: documentation, https://github.com/brettonsimpson/darkplotter
Keywords: Galactic Dynamics,Rotation Curves,Plummer Model,Galaxies,Extragalactic Astronomy
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib >=3.7.1
Requires-Dist: numpy >=1.24.2
Requires-Dist: pandas >=2.0.0
Requires-Dist: scipy >=1.10.1
Requires-Dist: astropy >=6.1.1

![Logo](https://media.discordapp.net/attachments/1254086159420887081/1263639533744816128/Untitled_design_1-removebg-preview.png?ex=669af786&is=6699a606&hm=07575cbb4f31e035fa7fc52002689a566673f61de68d9ac9693e1370776a3373&=&format=webp&quality=lossless&width=625&height=625) 

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

![GitHub top language](https://img.shields.io/github/languages/top/brettonsimpson/group-13)

![A rectangular badge, half black half purple containing the text made at Code Astro](https://img.shields.io/badge/Made%20at-Code/Astro-blueviolet.svg)

![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/brettonsimpson/group-13)


# Dark Plotter

Dark Plotter is a Python package for visualizing velocity as a function of radius for the Milky Way galaxy in an interactive way. This Python package was developed as a project for the Code/Astro workshop in 2024. [Code/Astro 2024](https://github.com/semaphoreP/codeastro)

The study of the orbital velocity of the galactic disk has provided astronomers with insights into the nature of dark matter, a substance that is so far not well understood, despite composing approximately one-third of the universal energy density. The equations of gravity, both classic and relativistic, fail to explain why galactic rotation curves do not decay as quickly as we expect they should with increasing distance from the core. Mathematical models to describe the gravitational potential profiles for galaxies as a function of radius, including the Navarro-Frenk-White, Plummer, Hernquist, and Jaffe profiles offer different perspectives on a galaxy's mass and velocity distribution. However, researchers and students often face challenges in visualizing and comparing these models with observed data, emphasizing the need for an interactive tool to aid in the teaching and exploration of galactic dynamics. This tool enables the direct comparison of the observed Milky Way velocity profile with the included models. 

# Attribution
If you use this code in your research work, please refer to the package by its name and cite the authors! If you have any questions, feel free to open an issue through GitHub.

# Getting Started

## Prerequisites

Before using this program, you'll need the following:

* Python 3.10 or higher installed on your system.
* Jupyter notebook.

## Installation

You can install **Dark Plotter** on Windows, MacOS, and Linux distributions. In either case, we assume that you have already installed the dependencies and the appropriate Python version. There are two options to install **Dark Plotter**:

## GitHub

You can install the latest sources from **Dark Plotter** by cloning the repository directly from GitHub:
```
$ git clone https://github.com/brettonsimpson/group-13
$ cd DarkPlotter
$ pip install INSERT PIP INSTALL IDENTIFIER
```
Or, instead, use `pip` with the path to the repository:
```
$ pip install Dark Plotter@git+https://github.com/brettonsimpson/group-13
```

## PyPI
A stable compiled version of **Dark Plotter** is available on [PyPI](https://pypi.org/). You can install it by running:
```
$ pip install Dark Plotter
```

## Testing

If you have installed the development version of **Dark Plotter** or cloned the complete source code (e.g., from the GitHub repository), you can run the tests by executing the following commands:

```python
$ cd Dark Plotter
$ python -m unittest -v
```

## Usage

1. Open Jupyter notebook.

2. Import the DarkPlotter :
``` python
import DarkPlotter
```
3. Use the plot function to create the interactive rotation curve plots.
``` python
DarkPlotter.plot()
```

## Contribution
1. Fork the repository and create a new branch for your feature or bug fix.

2. Make your changes, and ensure that your code follows the PEP 8 style guide.

3. Write tests to cover your code if applicable.

4. Create a pull request with a clear description of your changes and why they are needed.

5. Your pull request will be reviewed, and once approved, it will be merged into the main branch.

## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/brettonsimpson/group-13/blob/develop/LICENSE) file for details.

## Acknowledgement


