Skip to content
This repository was archived by the owner on Oct 14, 2023. It is now read-only.

installation.md

Latest commit

 

History

History
95 lines (70 loc) · 3.47 KB

installation.md

File metadata and controls

95 lines (70 loc) · 3.47 KB

Installation

Requirements

poliastro requires a number of Python packages, notably:

  • Astropy, for physical units and time handling
  • NumPy, for basic numerical routines
  • jplephem, for the planetary ephemerides using SPICE kernels
  • matplotlib, for static orbit plotting
  • numba (when using CPython), for accelerating the code
  • Plotly, for interactive orbit plotting
  • SciPy, for root finding and numerical propagation

poliastro is supported on Linux, macOS and Windows on Python 3.8 to 3.10.

Using conda

The easiest and fastest way to get the package up and running is to install poliastro using conda:

$ conda install -c conda-forge poliastro

or, better yet, using mamba, which is a super fast replacement for conda:

$ conda install -c conda-forge mamba
$ mamba install -c conda-forge poliastro
We encourage users to use conda or mamba
and the [conda-forge](https://conda-forge.org/) packages
for convenience,
especially when developing on Windows.
It is recommended to create a new environment.

If the installation fails for any reason, please open an issue in the issue tracker.

Alternative installation methods

You can also install poliastro from PyPI using pip:

$ pip install poliastro

Finally, you can also install the latest development version of poliastro directly from GitHub:

$ pip install https://github.com/poliastro/poliastro/archive/main.zip

This is useful if there is some feature that you want to try, but we did not release it yet as a stable version. Although you might find some unpolished details, these development installations should work without problems. If you find any, please open an issue in the issue tracker.

It is recommended that you
**never ever use sudo** with distutils, pip, setuptools and friends in Linux
because you might seriously break your system
\[[1](http://wiki.python.org/moin/CheeseShopTutorial#Distutils_Installation)\]\[[2](http://stackoverflow.com/questions/4314376/how-can-i-install-a-python-egg-file/4314446#comment4690673_4314446)\]\[[3](http://workaround.org/easy-install-debian)\]\[[4](http://matplotlib.1069221.n5.nabble.com/Why-is-pip-not-mentioned-in-the-Installation-Documentation-tp39779p39812.html)\].
Use [virtual environments](https://docs.python.org/3/library/venv.html) instead.

Making poliastro work in your editor

Jupyter notebook and JupyterLab

To install the extra dependencies needed to make the interactive plots work on Jupyter, do

$ pip install poliastro[jupyter]

With Plotly versions older than 5 on JupyterLab, you will also need to install Node.js to enable the browser extensions. Check out their troubleshooting guide for further information.

Problems and suggestions

If for any reason you get an unexpected error message or an incorrect result, or you want to let the developers know about your use case, please open a new issue in the issue tracker and we will try to answer promptly.