# ``ExoNAMD``
[](https://badge.fury.io/py/exonamd)
[](https://badge.fury.io/gh/abocchieri%2Fexonamd)
[](https://pepy.tech/project/exonamd)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://exonamd.readthedocs.io/en/stable/?badge=stable)
## Introduction
``ExoNAMD`` is a Python package to compute the Normalized Angular Momentum Deficit (NAMD) of exoplanetary systems. The NAMD is a measure of the dynamical excitation of a planetary system, and it can be defined as the difference between the total angular momentum of the system and the angular momentum it would have if all planets were on circular, coplanar orbits.
``ExoNAMD`` is designed to be fast, modern, and reliable. It is built using the latest Python features and libraries, and it is tested extensively to ensure its accuracy and reliability.
## Table of contents
- [``ExoNAMD``](#exonamd)
- [Introduction](#introduction)
- [Table of contents](#table-of-contents)
- [How to install](#how-to-install)
- [Install from PyPI](#install-from-pypi)
- [Install from source code](#install-from-source-code)
- [Test your installation](#test-your-installation)
- [Documentation](#documentation)
- [Build the html documentation](#build-the-html-documentation)
- [Build the pdf documentation](#build-the-pdf-documentation)
- [How to contribute](#how-to-contribute)
- [How to cite](#how-to-cite)
## How to install
Instructions on how to install ``ExoNAMD``.
### Install from PyPI
``ExoNAMD`` is available on PyPI and can be installed via pip as
pip install exonamd
### Install from source code
``ExoNAMD`` is compatible (tested) with Python 3.8+
To install from source, clone the [repository](https://github.com/abocchieri/ExoNAMD) and move inside the directory.
Then use `pip` as
pip install .
#### Test your installation
Try importing ``ExoNAMD`` as
python -c "import exonamd; print(exonamd.__version__)"
Or running ``ExoNAMD`` itself with the `help` flag as
exonamd -h
If there are no errors then the installation was successful!
## Documentation
``ExoNAMD`` comes with an extensive documentation, which can be built using Sphinx.
The documentation includes a tutorial, a user guide and a reference guide.
To build the documentation, install the needed packages first via `poetry`:
pip install poetry
poetry install --with docs
### Build the html documentation
To build the html documentation, move into the `docs` directory and run
make html
The documentation will be produced into the `build/html` directory inside `docs`.
Open `index.html` to read the documentation.
### Build the pdf documentation
To build the pdf, move into the `docs` directory and run
make latexpdf
The documentation will be produced into the `build/latex` directory inside `docs`.
Open `exonamd.pdf` to read the documentation.
The developers use `pdflatex`; if you have another compiler for LaTex, please refer to [sphinx documentation](https://www.sphinx-doc.org/en/master/usage/configuration.html#latex-options).
## How to contribute
You can contribute to ``ExoNAMD`` by reporting bugs, suggesting new features, or contributing to the code itself.
If you wish to contribute to the code, please follow the steps described in the documentation under `Developer Guide`.
## How to cite
```bibtex
@ARTICLE{Bocchieri2025,
author = {{Bocchieri}, Andrea and {Zak}, Jiri and {Turrini}, Diego},
title = "{ExoNAMD: Leveraging the spin-orbit angle to constrain the dynamics of multiplanetary systems}",
journal = {in preparation},
year = 2025,
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "exonamd",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "exoplanets, planetary systems, multiplanetary systems, Python, Angular Momentum Deficit, Normalized Angular Momentum Deficit, Stellar obliquity, Planet formation, Planet evolution, Planet migration",
"author": "Andrea Bocchieri",
"author_email": "andrea.bocchieri@uniroma1.it",
"download_url": "https://files.pythonhosted.org/packages/dc/26/77e4c5bacc6908860751a57dbdc2ed41479bba2ad9197178af80a76778db/exonamd-0.3.1.tar.gz",
"platform": null,
"description": "# ``ExoNAMD``\n\n[](https://badge.fury.io/py/exonamd)\n[](https://badge.fury.io/gh/abocchieri%2Fexonamd)\n[](https://pepy.tech/project/exonamd)\n[](https://opensource.org/licenses/BSD-3-Clause)\n[](https://exonamd.readthedocs.io/en/stable/?badge=stable)\n\n## Introduction\n\n``ExoNAMD`` is a Python package to compute the Normalized Angular Momentum Deficit (NAMD) of exoplanetary systems. The NAMD is a measure of the dynamical excitation of a planetary system, and it can be defined as the difference between the total angular momentum of the system and the angular momentum it would have if all planets were on circular, coplanar orbits.\n\n``ExoNAMD`` is designed to be fast, modern, and reliable. It is built using the latest Python features and libraries, and it is tested extensively to ensure its accuracy and reliability.\n\n## Table of contents\n\n- [``ExoNAMD``](#exonamd)\n - [Introduction](#introduction)\n - [Table of contents](#table-of-contents)\n - [How to install](#how-to-install)\n - [Install from PyPI](#install-from-pypi)\n - [Install from source code](#install-from-source-code)\n - [Test your installation](#test-your-installation)\n - [Documentation](#documentation)\n - [Build the html documentation](#build-the-html-documentation)\n - [Build the pdf documentation](#build-the-pdf-documentation)\n - [How to contribute](#how-to-contribute)\n - [How to cite](#how-to-cite)\n\n## How to install\n\nInstructions on how to install ``ExoNAMD``.\n\n### Install from PyPI\n\n``ExoNAMD`` is available on PyPI and can be installed via pip as\n\n pip install exonamd\n\n### Install from source code\n\n``ExoNAMD`` is compatible (tested) with Python 3.8+\n\nTo install from source, clone the [repository](https://github.com/abocchieri/ExoNAMD) and move inside the directory.\n\nThen use `pip` as\n\n pip install .\n\n#### Test your installation\n\nTry importing ``ExoNAMD`` as\n\n python -c \"import exonamd; print(exonamd.__version__)\"\n\nOr running ``ExoNAMD`` itself with the `help` flag as\n\n exonamd -h\n\nIf there are no errors then the installation was successful!\n\n## Documentation\n\n``ExoNAMD`` comes with an extensive documentation, which can be built using Sphinx.\nThe documentation includes a tutorial, a user guide and a reference guide.\n\nTo build the documentation, install the needed packages first via `poetry`:\n\n pip install poetry\n poetry install --with docs\n\n### Build the html documentation\n\nTo build the html documentation, move into the `docs` directory and run\n\n make html\n\nThe documentation will be produced into the `build/html` directory inside `docs`.\nOpen `index.html` to read the documentation.\n\n### Build the pdf documentation\n\nTo build the pdf, move into the `docs` directory and run\n\n make latexpdf\n\nThe documentation will be produced into the `build/latex` directory inside `docs`.\nOpen `exonamd.pdf` to read the documentation.\n\nThe developers use `pdflatex`; if you have another compiler for LaTex, please refer to [sphinx documentation](https://www.sphinx-doc.org/en/master/usage/configuration.html#latex-options).\n\n## How to contribute\n\nYou can contribute to ``ExoNAMD`` by reporting bugs, suggesting new features, or contributing to the code itself.\nIf you wish to contribute to the code, please follow the steps described in the documentation under `Developer Guide`.\n\n## How to cite\n\n```bibtex\n@ARTICLE{Bocchieri2025,\n author = {{Bocchieri}, Andrea and {Zak}, Jiri and {Turrini}, Diego},\n title = \"{ExoNAMD: Leveraging the spin-orbit angle to constrain the dynamics of multiplanetary systems}\",\n journal = {in preparation},\n year = 2025,\n}\n```\n\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "ExoNAMD is a Python codebase to compute the Normalized Angular Momentum Deficit of planetary systems.",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/abocchieri/ExoNAMD/issues",
"Homepage": "https://github.com/abocchieri/ExoNAMD",
"Repository": "https://github.com/abocchieri/ExoNAMD.git"
},
"split_keywords": [
"exoplanets",
" planetary systems",
" multiplanetary systems",
" python",
" angular momentum deficit",
" normalized angular momentum deficit",
" stellar obliquity",
" planet formation",
" planet evolution",
" planet migration"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e7ef3455eee6a2525357a8f71801f6d6c803d9122a892cc9f49cbe58fd5f4257",
"md5": "aa317bfc41669f231553bd3a8a70b3b9",
"sha256": "3c52975f7e1a919b08508650d10feb90dbb5fd3af30f96947e49babe7c3e5932"
},
"downloads": -1,
"filename": "exonamd-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa317bfc41669f231553bd3a8a70b3b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 776241,
"upload_time": "2025-08-23T18:25:50",
"upload_time_iso_8601": "2025-08-23T18:25:50.958358Z",
"url": "https://files.pythonhosted.org/packages/e7/ef/3455eee6a2525357a8f71801f6d6c803d9122a892cc9f49cbe58fd5f4257/exonamd-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dc2677e4c5bacc6908860751a57dbdc2ed41479bba2ad9197178af80a76778db",
"md5": "00884d0eb7d9302aed5875e1ac3497bc",
"sha256": "5ac513471d475cce7ea08a7199d5119a0ac9e19a2e4f13afee7070ece964c82e"
},
"downloads": -1,
"filename": "exonamd-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "00884d0eb7d9302aed5875e1ac3497bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 718427,
"upload_time": "2025-08-23T18:25:53",
"upload_time_iso_8601": "2025-08-23T18:25:53.383687Z",
"url": "https://files.pythonhosted.org/packages/dc/26/77e4c5bacc6908860751a57dbdc2ed41479bba2ad9197178af80a76778db/exonamd-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 18:25:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abocchieri",
"github_project": "ExoNAMD",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "exonamd"
}
JSON
