| Name | our-package-name JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A package to plot interactive dynamic models for Code/Astro 2024 |
| upload_time | 2024-07-17 15:22:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| 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. |
| keywords |
galactic dynamics
rotation curves
plummer model
galaxies
extragalactic astronomy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# group-13 Project
**Package name** is a Python 3 package to visualize the orbital radius for the Milky Way galaxy, in an interacting way. It is distributed over the MIT License. This Python package is associated with the main activites of [Code/Astro 2024](https://github.com/semaphoreP/codeastro).
# Statement of need
Understanding the dynamics and structure of the Milky Way galaxy is a fundamental goal in astrophysics. A critical aspect of this is analyzing the rotation curve, which represents the orbital velocity of stars and gas as a function of their distance from the galactic center. Discrepancies between observed rotation curves and those predicted by visible matter alone have led to the hypothesis of dark matter, necessitating more sophisticated models. Traditional models like the Triaxial NFW Potential, Plummer Potential, and Exponential Potential offer different perspectives on the galaxy's mass distribution. However, researchers and students often face challenges in visualizing and comparing these models with observed data, highlighting the need for an intuitive, interactive tool to aid in the exploration and understanding of galactic dynamics.
Our Python package addresses this need by providing an interactive platform to visualize and analyze the orbital radius as a function of velocity for the Milky Way galaxy. Users can adjust parameters for the Triaxial NFW, Plummer, and Exponential potentials to see how each model affects the simulated velocity profile. This tool allows for direct comparison with observed velocity profiles, facilitating a deeper understanding of galactic dynamics and the influence of different mass distribution models. By making these complex models accessible and manipulatable, our package serves as an additional resource for both educational and research purposes in astrophysics.
# Attribution
If you use this code in your research work, please refer to the package by its name and cite the authors!. Any question, please start an issue!.
# Dependencies and Installation
This repository requires Python 3.10 or high, and a list of packages downloaded automatically ([numpy](https://github.com/numpy/numpy), [scipy](https://scipy.org/), etc.). In addition, it is required to install all the dependencies related to [plotly](https://plotly.com/python/).
# Installing **Package_Name**
You can install **Package_Name** on Windows, MacOs and Linux distributions. In both cases, we assume that you have already installed the dependencies and the appropriate Python version. Now, there are two options to install **ClassiPyGRB**:
## GitHub
You can install the latest sources from **ClassiPyGRB** by cloning the repository directly from GitHub:
```
$ git clone https://github.com/brettonsimpson/group-13
$ cd package_name
$ pip install .
```
Or, instead, use `pip` with the path to the repository:
```
$ pip install package_name@git+https://github.com/brettonsimpson/group-13
```
## PyPI
A stable compiled version of **ClassiPyGRB** is available on [PyPI](https://pypi.org/). You can install it by running:
```
$ pip install package_name
```
## Testing
If you have installed the development version of **Package_Name** or cloned the complete source code (e.g., from the GitHub repository), you can run the tests by executing the following commands:
```
$ cd package_name
$ python -m unittest -v
```
Raw data
{
"_id": null,
"home_page": null,
"name": "our-package-name",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Keneth Garcia <stivengarcia7113@gmail.com>",
"keywords": "Galactic Dynamics, Rotation Curves, Plummer Model, Galaxies, Extragalactic Astronomy",
"author": null,
"author_email": "\"Garcia-Cifuentes, K.\" <stivengarcia7113@gmail.com>, Bretton <Bretton@example.com>, Elizabeth <Elizabeth@example.com>, Alcatraz <Alcatraz@example.com>, Dionysis <Dionysis@example.com>",
"download_url": "https://files.pythonhosted.org/packages/13/63/0ac845ff5f89e0fad47ecc5a8a8358376f46dbb1ba1ea22cde5cf5aedc43/our_package_name-1.0.0.tar.gz",
"platform": null,
"description": " \n\n# group-13 Project\n\n**Package name** is a Python 3 package to visualize the orbital radius for the Milky Way galaxy, in an interacting way. It is distributed over the MIT License. This Python package is associated with the main activites of [Code/Astro 2024](https://github.com/semaphoreP/codeastro).\n\n# Statement of need\nUnderstanding the dynamics and structure of the Milky Way galaxy is a fundamental goal in astrophysics. A critical aspect of this is analyzing the rotation curve, which represents the orbital velocity of stars and gas as a function of their distance from the galactic center. Discrepancies between observed rotation curves and those predicted by visible matter alone have led to the hypothesis of dark matter, necessitating more sophisticated models. Traditional models like the Triaxial NFW Potential, Plummer Potential, and Exponential Potential offer different perspectives on the galaxy's mass distribution. However, researchers and students often face challenges in visualizing and comparing these models with observed data, highlighting the need for an intuitive, interactive tool to aid in the exploration and understanding of galactic dynamics.\n\nOur Python package addresses this need by providing an interactive platform to visualize and analyze the orbital radius as a function of velocity for the Milky Way galaxy. Users can adjust parameters for the Triaxial NFW, Plummer, and Exponential potentials to see how each model affects the simulated velocity profile. This tool allows for direct comparison with observed velocity profiles, facilitating a deeper understanding of galactic dynamics and the influence of different mass distribution models. By making these complex models accessible and manipulatable, our package serves as an additional resource for both educational and research purposes in astrophysics.\n\n# Attribution\nIf you use this code in your research work, please refer to the package by its name and cite the authors!. Any question, please start an issue!.\n\n# Dependencies and Installation\n\nThis repository requires Python 3.10 or high, and a list of packages downloaded automatically ([numpy](https://github.com/numpy/numpy), [scipy](https://scipy.org/), etc.). In addition, it is required to install all the dependencies related to [plotly](https://plotly.com/python/).\n\n# Installing **Package_Name**\n\nYou can install **Package_Name** on Windows, MacOs and Linux distributions. In both cases, we assume that you have already installed the dependencies and the appropriate Python version. Now, there are two options to install **ClassiPyGRB**:\n\n## GitHub\n\nYou can install the latest sources from **ClassiPyGRB** by cloning the repository directly from GitHub:\n```\n$ git clone https://github.com/brettonsimpson/group-13\n$ cd package_name\n$ pip install .\n```\nOr, instead, use `pip` with the path to the repository:\n```\n$ pip install package_name@git+https://github.com/brettonsimpson/group-13\n```\n\n## PyPI\nA stable compiled version of **ClassiPyGRB** is available on [PyPI](https://pypi.org/). You can install it by running:\n```\n$ pip install package_name\n```\n\n## Testing\n\nIf you have installed the development version of **Package_Name** or cloned the complete source code (e.g., from the GitHub repository), you can run the tests by executing the following commands:\n\n```\n$ cd package_name\n$ python -m unittest -v\n```\n",
"bugtrack_url": null,
"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. ",
"summary": "A package to plot interactive dynamic models for Code/Astro 2024",
"version": "1.0.0",
"project_urls": {
"documentation": "https://github.com/brettonsimpson/group-13/tree/Keneth_updates/docs",
"homepage": "https://github.com/brettonsimpson/group-13"
},
"split_keywords": [
"galactic dynamics",
" rotation curves",
" plummer model",
" galaxies",
" extragalactic astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8dc2d45102fab8cb73b0da9b1205036e8d810782d9e8b80a4f4b330e63d8e1d",
"md5": "d4363e2050a1472d33a5777546eff0b9",
"sha256": "6836daf30f5085ce0979bc61f06fa80796937568342a662679917fb99010b0f8"
},
"downloads": -1,
"filename": "our_package_name-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4363e2050a1472d33a5777546eff0b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5322,
"upload_time": "2024-07-17T15:22:12",
"upload_time_iso_8601": "2024-07-17T15:22:12.997463Z",
"url": "https://files.pythonhosted.org/packages/c8/dc/2d45102fab8cb73b0da9b1205036e8d810782d9e8b80a4f4b330e63d8e1d/our_package_name-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13630ac845ff5f89e0fad47ecc5a8a8358376f46dbb1ba1ea22cde5cf5aedc43",
"md5": "9d3628e4bb8957826fc96febcc9ffeef",
"sha256": "b0479163e80b322657e237329df07a13a69a09fb43af2ffc18237ef720a3eb5d"
},
"downloads": -1,
"filename": "our_package_name-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9d3628e4bb8957826fc96febcc9ffeef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5826,
"upload_time": "2024-07-17T15:22:14",
"upload_time_iso_8601": "2024-07-17T15:22:14.569933Z",
"url": "https://files.pythonhosted.org/packages/13/63/0ac845ff5f89e0fad47ecc5a8a8358376f46dbb1ba1ea22cde5cf5aedc43/our_package_name-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-17 15:22:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brettonsimpson",
"github_project": "group-13",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "our-package-name"
}
