- Operating system: Windows, MacOS/Mac OS X, and Linux
- Python: 3.5, 3.6, and 3.7
We highly recommend installing and using the free Anaconda distribution of Python (or Miniconda, if you don’t want all of the extra packages that come built-in with Anaconda), which works on Mac, Linux, and Windows, both on normal computers and institutional clusters and doesn’t require root permissions.
See e.g. this blog post for instructions on how to install Miniconda on a large cluster without root permission.
Recommended installation method: conda¶
The recommended installation method is via conda
conda install -c conda-forge aospy
Alternative method #1: pip¶
aospy is available from the official Python Packaging Index (PyPI) via
pip install aospy
Alternative method #2: clone from Github¶
You can also directly clone the Github repo
git clone https://www.github.com/spencerahill/aospy.git cd aospy python setup.py install
Verifying proper installation¶
Once installed via any of these methods, you can run aospy’s suite of tests using py.test. From the top-level directory of the aospy installation
conda install pytest # if you don't have it already; or 'pip install pytest' py.test aospy
If you don’t know the directory where aospy was installed, you can find it via
python -c "import aospy; print(aospy.__path__)"
If the pytest command results in any error messages or test failures, something has gone wrong, and please refer to the Troubleshooting information below.
Please search through our Issues page on Github and our mailing list to see if anybody else has had the same problem you’re facing. If none do, then please send a message on the list or open a new Issue.
Please don’t hesitate, especially if you’re new to the package and/or Python! We are eager to help people get started. Even you suspect it’s something simple or obvious – that just means we didn’t make it clear/easy enough!