poliastro requires the following Python packages:
- NumPy, for basic numerical routines
- Astropy, for physical units and time handling
- numba (optional), for accelerating the code
- jplephem, for the planetary ephemerides using SPICE kernels
- Plotly, for interactive orbit plotting
- matplotlib, for static orbit plotting
- SciPy, for root finding and numerical propagation
- pytest, for running the tests from the package
poliastro is usually tested on Linux, Windows and OS X on Python 3.5, 3.6 and 3.7 against latest NumPy.
The easiest and fastest way to get the package up and running is to install poliastro using conda:
$ conda install poliastro --channel conda-forge
We encourage users to use conda and the conda-forge packages for convenience, especially when developing on Windows.
If the installation fails for any reason, please open an issue in the issue tracker.
Alternative installation methods¶
If you don’t want to use conda you can install poliastro from PyPI using pip:
$ pip install numpy # Run this one first for pip 9 and older! $ pip install poliastro[jupyter] pytest
Finally, you can also install the latest development version of poliastro directly from GitHub:
$ pip install https://github.com/poliastro/poliastro/archive/master.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.
Using poliastro on JupyterLab¶
After the release of Plotly 3.0, plotting orbits using poliastro is easier than ever.
You have to install three extensions of JupyterLab to make your experience smooth:
$ jupyter labextension install @email@example.com $ jupyter labextension install firstname.lastname@example.org $ jupyter labextension install @email@example.com
And as the documentation of JupyterLab Extensions states:
“In order to install JupyterLab extensions, you need to have Node.js version 4 or later installed.”
If you face any further issues, you can refer to the installation guide by Plotly.
If installed correctly, the tests can be run using pytest:
$ python -c "import poliastro.testing; poliastro.testing.test()" ===================================== test session starts ===================================== platform linux -- Python 3.7.1, pytest-4.2.0, py-1.7.0, pluggy-0.8.1 rootdir: /home/juanlu/.miniconda36/envs/_test37/lib/python3.7/site-packages/poliastro, inifile: collected 747 items [...] ========= 738 passed, 3 skipped, 5 xfailed, 1 xpassed, 13 warnings in 392.12 seconds ========== $
If for some reason any test fails, please report it in the issue tracker.